Skip to content

Commit 324440c

Browse files
authored
Merge pull request #10647 from Calinou/intro-build-system-target-template-debug
Fix meaning of `target=template_debug` in Introduction to the buildsystem
2 parents 95743e3 + 8ee0e4f commit 324440c

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

contributing/development/compiling/introduction_to_the_buildsystem.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,20 +125,24 @@ build targets, and which will be explained below.
125125
Target
126126
------
127127

128-
Target controls if the editor is contained and debug flags are used.
129-
All builds are optimized. Each mode means:
128+
The ``target`` option controls if the editor is compiled and debug flags are used.
129+
Optimization levels (``optimize``) and whether each build contains debug symbols
130+
(``debug_symbols``) is controlled separately from the target. Each mode means:
130131

131-
- ``target=editor``: Build with editor, optimized, with debugging code (defines: ``TOOLS_ENABLED``, ``DEBUG_ENABLED``, ``-O2``/``/O2``)
132-
- ``target=template_debug``: Build with C++ debugging symbols (defines: ``DEBUG_ENABLED``, ``-O2``/``/O2``)
133-
- ``target=template_release``: Build without symbols (defines: ``-O3``/``/O2``)
132+
- ``target=editor``: Build an editor binary (defines ``TOOLS_ENABLED`` and ``DEBUG_ENABLED``)
133+
- ``target=template_debug``: Build a debug export template (defines ``DEBUG_ENABLED``)
134+
- ``target=template_release``: Build a release export template
134135

135136
The editor is enabled by default in all PC targets (Linux, Windows, macOS),
136137
disabled for everything else. Disabling the editor produces a binary that can
137138
run projects but does not include the editor or the Project Manager.
138139

140+
The list of :ref:`command line arguments <doc_command_line_tutorial>`
141+
available varies depending on the build type.
142+
139143
::
140144

141-
scons platform=<platform> target=editor/template_debug/template_release
145+
scons platform=<platform> target=editor|template_debug|template_release
142146

143147
.. _doc_introduction_to_the_buildsystem_development_and_production_aliases:
144148

0 commit comments

Comments
 (0)