summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/gdc.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/gdc.xml')
-rw-r--r--src/engine/SCons/Tool/gdc.xml356
1 files changed, 170 insertions, 186 deletions
diff --git a/src/engine/SCons/Tool/gdc.xml b/src/engine/SCons/Tool/gdc.xml
index dc3d8bf..8f71b5d 100644
--- a/src/engine/SCons/Tool/gdc.xml
+++ b/src/engine/SCons/Tool/gdc.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
-Copyright (c) 2001 - 2016 The SCons Foundation
+Copyright (c) 2001 - 2017 The SCons Foundation
This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
@@ -32,10 +32,6 @@ Sets construction variables for the D language compiler GDC.
<sets>
<item>DC</item>
<item>DCOM</item>
-<item>_DINCFLAGS</item>
-<item>_DVERFLAGS</item>
-<item>_DDEBUGFLAGS</item>
-<item>_DFLAGS</item>
<item>SHDC</item>
<item>SHDCOM</item>
<item>DPATH</item>
@@ -57,16 +53,21 @@ Sets construction variables for the D language compiler GDC.
<item>SHDLINK</item>
<item>SHDLINKFLAGS</item>
<item>SHDLINKCOM</item>
+<item>DLIBLINKPREFIX</item>
+<item>DLIBLINKSUFFIX</item>
+<item>DLIBDIRPREFIX</item>
+<item>DLIBDIRSUFFIX</item>
<item>DLIB</item>
<item>DLIBCOM</item>
-<item>_DLIBFLAGS</item>
<item>DLIBFLAGPREFIX</item>
<item>DLIBFLAGSUFFIX</item>
<item>DLINKFLAGPREFIX</item>
<item>DLINKFLAGSUFFIX</item>
-<item>RPATHPREFIX</item>
-<item>RPATHSUFFIX</item>
-<item>_RPATH</item>
+<item>DRPATHPREFIX</item>
+<item>DRPATHSUFFIX</item>
+<item>DShLibSonameGenerator</item>
+<item>SHDLIBVERSION</item>
+<item>SHDLIBVERSIONFLAGS</item>
</sets>
<uses>
</uses>
@@ -75,7 +76,7 @@ Sets construction variables for the D language compiler GDC.
<cvar name="DC">
<summary>
<para>
-DC.
+The D compiler to use.
</para>
</summary>
</cvar>
@@ -83,7 +84,9 @@ DC.
<cvar name="DCOM">
<summary>
<para>
-DCOM.
+ The command line used to compile a D file to an object file.
+ Any options specified in the &cv-link-DFLAGS; construction variable
+ is included on this command line.
</para>
</summary>
</cvar>
@@ -91,39 +94,7 @@ DCOM.
<cvar name="DDEBUG">
<summary>
<para>
-DDEBUG.
-</para>
-</summary>
-</cvar>
-
-<cvar name="DDEBUGPREFIX">
-<summary>
-<para>
-DDEBUGPREFIX.
-</para>
-</summary>
-</cvar>
-
-<cvar name="DDEBUGSUFFIX">
-<summary>
-<para>
-DDEBUGSUFFIX.
-</para>
-</summary>
-</cvar>
-
-<cvar name="DFILESUFFIX">
-<summary>
-<para>
-DFILESUFFIX.
-</para>
-</summary>
-</cvar>
-
-<cvar name="DFLAGPREFIX">
-<summary>
-<para>
-DFLAGPREFIX.
+ List of debug tags to enable when compiling.
</para>
</summary>
</cvar>
@@ -131,257 +102,270 @@ DFLAGPREFIX.
<cvar name="DFLAGS">
<summary>
<para>
-DFLAGS.
-</para>
-</summary>
-</cvar>
-
-<cvar name="DFLAGSUFFIX">
-<summary>
-<para>
-DFLAGSUFFIX.
+ General options that are passed to the D compiler.
</para>
</summary>
</cvar>
-<cvar name="DINCPREFIX">
+<cvar name="DLIB">
<summary>
<para>
-DINCPREFIX.
+ Name of the lib tool to use for D codes.
</para>
</summary>
</cvar>
-<cvar name="DINCSUFFIX">
+<cvar name="DLIBCOM">
<summary>
<para>
-DINCSUFFIX.
+ The command line to use when creating libraries.
</para>
</summary>
</cvar>
-<cvar name="DLIB">
+<cvar name="DLINK">
<summary>
<para>
-DLIB.
+ Name of the linker to use for linking systems including D sources.
</para>
</summary>
</cvar>
-<cvar name="DLIBCOM">
+<cvar name="DLINKCOM">
<summary>
<para>
-DLIBCOM.
+ The command line to use when linking systems including D sources.
</para>
</summary>
</cvar>
-<cvar name="DLIBDIRPREFIX">
+<cvar name="DLINKFLAGS">
<summary>
<para>
-DLIBDIRPREFIX.
+List of linker flags.
</para>
</summary>
</cvar>
-<cvar name="DLIBDIRSUFFIX">
+<cvar name="DPATH">
<summary>
<para>
-DLIBDIRSUFFIX.
+ List of paths to search for import modules.
</para>
</summary>
</cvar>
-<cvar name="DLIBFLAGPREFIX">
+<cvar name="DVERSIONS">
<summary>
<para>
-DLIBFLAGPREFIX.
+ List of version tags to enable when compiling.
</para>
</summary>
</cvar>
-<cvar name="DLIBFLAGSUFFIX">
+<cvar name="SHDC">
<summary>
<para>
-DLIBFLAGSUFFIX.
+ The name of the compiler to use when compiling D source
+ destined to be in a shared objects.
</para>
</summary>
</cvar>
-<cvar name="DLIBLINKPREFIX">
+<cvar name="SHDCOM">
<summary>
<para>
-DLIBLINKPREFIX.
+ The command line to use when compiling code to be part of shared objects.
</para>
</summary>
</cvar>
-<cvar name="DLIBLINKSUFFIX">
+<cvar name="SHDLINK">
<summary>
<para>
-DLIBLINKSUFFIX.
+ The linker to use when creating shared objects for code bases
+ include D sources.
</para>
</summary>
</cvar>
-<cvar name="DLINK">
+<cvar name="SHDLINKCOM">
<summary>
<para>
-DLINK.
+ The command line to use when generating shared objects.
</para>
</summary>
</cvar>
-<cvar name="DLINKCOM">
+<cvar name="SHDLINKFLAGS">
<summary>
<para>
-DLINKCOM.
+ The list of flags to use when generating a shared object.
</para>
</summary>
</cvar>
-<cvar name="DLINKFLAGPREFIX">
-<summary>
-<para>
-DLINKFLAGPREFIX.
-</para>
-</summary>
+<cvar name="DVERSUFFIX">
+ <summary>
+ <para>
+ DVERSUFFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="DLINKFLAGS">
-<summary>
-<para>
-DLINKFLAGS.
-</para>
-</summary>
+<cvar name="DVERPREFIX">
+ <summary>
+ <para>
+ DVERPREFIX.
+ </para>
+ </summary>
</cvar>
<cvar name="DLINKFLAGSUFFIX">
-<summary>
-<para>
-DLINKFLAGSUFFIX.
-</para>
-</summary>
+ <summary>
+ <para>
+ DLINKFLAGSUFFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="DPATH">
-<summary>
-<para>
-DPATH.
-</para>
-</summary>
+<cvar name="DLINKFLAGPREFIX">
+ <summary>
+ <para>
+ DLINKFLAGPREFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="DVERPREFIX">
-<summary>
-<para>
-DVERPREFIX.
-</para>
-</summary>
+<cvar name="DLIBLINKSUFFIX">
+ <summary>
+ <para>
+ DLIBLINKSUFFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="DVERSIONS">
-<summary>
-<para>
-DVERSIONS.
-</para>
-</summary>
+<cvar name="DLIBLINKPREFIX">
+ <summary>
+ <para>
+ DLIBLINKPREFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="DVERSUFFIX">
-<summary>
-<para>
-DVERSUFFIX.
-</para>
-</summary>
+<cvar name="DLIBFLAGSUFFIX">
+ <summary>
+ <para>
+ DLIBFLAGSUFFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="SHDC">
-<summary>
-<para>
-SHDC.
-</para>
-</summary>
+<cvar name="DLIBFLAGPREFIX">
+ <summary>
+ <para>
+ DLIBFLAGPREFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="SHDCOM">
-<summary>
-<para>
-SHDCOM.
-</para>
-</summary>
+<cvar name="DLIBDIRSUFFIX">
+ <summary>
+ <para>
+ DLIBLINKSUFFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="SHDLINK">
-<summary>
-<para>
-SHDLINK.
-</para>
-</summary>
+<cvar name="DLIBDIRPREFIX">
+ <summary>
+ <para>
+ DLIBLINKPREFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="SHDLINKCOM">
-<summary>
-<para>
-SHDLINKCOM.
-</para>
-</summary>
+<cvar name="DINCSUFFIX">
+ <summary>
+ <para>
+ DLIBFLAGSUFFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="SHDLINKFLAGS">
-<summary>
-<para>
-SHDLINKFLAGS.
-</para>
-</summary>
-</cvar>
-<cvar name="_DDEBUGFLAGS">
-<summary>
-<para>
-_DDEBUGFLAGS.
-</para>
-</summary>
+<cvar name="DINCPREFIX">
+ <summary>
+ <para>
+ DINCPREFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="_DFLAGS">
-<summary>
-<para>
-_DFLAGS.
-</para>
-</summary>
+<cvar name="DFLAGSUFFIX">
+ <summary>
+ <para>
+ DFLAGSUFFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="_DINCFLAGS">
-<summary>
-<para>
-_DINCFLAGS.
-</para>
-</summary>
+<cvar name="DFLAGPREFIX">
+ <summary>
+ <para>
+ DFLAGPREFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="_DLIBDIRFLAGS">
-<summary>
-<para>
-_DLIBDIRFLAGS.
-</para>
-</summary>
+<cvar name="DFILESUFFIX">
+ <summary>
+ <para>
+ DFILESUFFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="_DLIBFLAGS">
-<summary>
-<para>
-_DLIBFLAGS.
-</para>
-</summary>
+<cvar name="DDEBUGPREFIX">
+ <summary>
+ <para>
+ DDEBUGPREFIX.
+ </para>
+ </summary>
</cvar>
-<cvar name="_DVERFLAGS">
-<summary>
-<para>
-_DVERFLAGS.
-</para>
-</summary>
-</cvar>
+<cvar name="DDEBUGSUFFIX">
+ <summary>
+ <para>
+ DDEBUGSUFFIX.
+ </para>
+ </summary>
+</cvar>
+
+<builder name="ProgramAllAtOnce">
+ <summary>
+ <para>
+ Builds an executable from D sources without first creating individual
+ objects for each file.
+ </para>
+ <para>
+ D sources can be compiled file-by-file as C and C++ source are, and
+ D is integrated into the &scons; Object and Program builders for
+ this model of build. D codes can though do whole source
+ meta-programming (some of the testing frameworks do this). For this
+ it is imperative that all sources are compiled and linked in a single call of
+ the D compiler. This builder serves that purpose.
+ </para>
+ <example_commands>
+ env.ProgramAllAtOnce('executable', ['mod_a.d, mod_b.d', 'mod_c.d'])
+ </example_commands>
+ <para>
+ This command will compile the modules mod_a, mod_b, and mod_c in a
+ single compilation process without first creating object files for
+ the modules. Some of the D compilers will create executable.o others
+ will not.
+ </para>
+ </summary>
+</builder>
</sconsdoc>