Skip to content

Commit

Permalink
Fix Introduction to the buildsystem links in CLI documentation (godot…
Browse files Browse the repository at this point in the history 
…engine#6483)
  • Loading branch information
@YuriSizov
YuriSizov authored Dec 12, 2022
1 parent d84c5ae commit 519e2ae
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions tutorials/editor/command_line_tutorial.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ Command line reference
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Command | Description |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--`` | Separator for user-provided arguments. Following arguments are not used by the engine, but can be read from `OS.get_cmdline_user_args()`. |
| ``--`` | Separator for user-provided arguments. Following arguments are not used by the engine, but can be read from ``OS.get_cmdline_user_args()``. |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-e``, ``--editor`` | Start the editor instead of running the scene (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
| ``-e``, ``--editor`` | Start the editor instead of running the scene (:ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must be used). |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-p``, ``--project-manager`` | Start the project manager, even if a project is auto-detected (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
| ``-p``, ``--project-manager`` | Start the project manager, even if a project is auto-detected (:ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must be used). |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--debug-server <uri>`` | Start the editor debug server (``<protocol>://<host/IP>[:<port>]``, e.g. ``tcp://127.0.0.1:6007``) |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -172,31 +172,31 @@ Command line reference
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--check-only`` | Only parse for errors and quit (use with ``--script``). |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--export-release <preset> <path>`` | Export the project using the given preset and matching release template (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be |
| | enabled). The preset name should match one defined in export_presets.cfg. ``<path>`` should be absolute or relative to the project directory, |
| ``--export-release <preset> <path>`` | Export the project using the given preset and matching release template (:ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must |
| | be used). The preset name should match one defined in export_presets.cfg. ``<path>`` should be absolute or relative to the project directory, |
| | and include the filename for the binary (e.g. 'builds/game.exe'). The target directory should exist. |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--export-debug <preset> <path>`` | Like ``--export-release``, but use debug template (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
| ``--export-debug <preset> <path>`` | Like ``--export-release``, but use debug template (:ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must be used). |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--export-pack <preset> <path>`` | Like ``--export-release``, but only export the game pack for the given preset. The ``<path>`` extension determines whether it will be in PCK |
| | or ZIP format (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
| | or ZIP format (:ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must be used). |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--convert-3to4 [<max_file_kb>] [<max_line_size>]`` | Converts project from Godot 3.x to Godot 4.x. |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--validate-conversion-3to4 [<max_file_kb>] [<max_line_size>]`` | Shows what elements will be renamed when converting project from Godot 3.x to Godot 4.x. |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--doctool <path>`` | Dump the engine API reference to the given ``<path>`` in XML format, merging if existing files are found |
| | (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
| | (:ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must be used). |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--no-docbase`` | Disallow dumping the base types (used with ``--doctool``, :ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
| ``--no-docbase`` | Disallow dumping the base types (used with ``--doctool``, :ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must be used). |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--build-solutions`` | Build the scripting solutions (e.g. for C# projects, :ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
| ``--build-solutions`` | Build the scripting solutions (e.g. for C# projects, :ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must be used). |
| | Implies ``--editor`` and requires a valid project to edit. |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--dump-gdextension-interface`` | Generate GDExtension header file 'gdnative_interface.h' in the current folder. This file is the base file required to implement a GDExtension. |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--dump-extension-api`` | Generate JSON dump of the Godot API for GDExtension bindings named 'extension_api.json' in the current folder |
| | (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
| | (:ref:`target=editor <doc_introduction_to_the_buildsystem_target>` must be used). |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--startup-benchmark`` | Benchmark the startup time and print it to console. |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down

0 comments on commit 519e2ae

Please sign in to comment.