summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/ldc.xml
blob: 9593f410210ba459a8ecdc58fdd3df9079bf56ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<?xml version="1.0" encoding="UTF-8"?>
<!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->

<!DOCTYPE sconsdoc [
<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'>
%scons;
<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'>
%builders-mod;
<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'>
%functions-mod;
<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'>
%tools-mod;
<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'>
%variables-mod;
]>

<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd">

<tool name="ldc">
<summary>
<para>
Sets construction variables for the D language compiler LDC2.
</para>
</summary>
<sets>
<item>DC</item>
<item>DCOM</item>
<item>SHDC</item>
<item>SHDCOM</item>
<item>DPATH</item>
<item>DFLAGS</item>
<item>DVERSIONS</item>
<item>DDEBUG</item>
<item>DINCPREFIX</item>
<item>DINCSUFFIX</item>
<item>DVERPREFIX</item>
<item>DVERSUFFIX</item>
<item>DDEBUGPREFIX</item>
<item>DDEBUGSUFFIX</item>
<item>DFLAGPREFIX</item>
<item>DFLAGSUFFIX</item>
<item>DFILESUFFIX</item>
<item>DLINK</item>
<item>DLINKFLAGS</item>
<item>DLINKCOM</item>
<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>DLIBFLAGPREFIX</item>
<item>DLIBFLAGSUFFIX</item>
<item>DLINKFLAGPREFIX</item>
<item>DLINKFLAGSUFFIX</item>
<item>RPATHPREFIX</item>
<item>RPATHSUFFIX</item>
</sets>
<uses>
</uses>
</tool>

<cvar name="DC">
<summary>
<para>
The D compiler to use.
</para>
</summary>
</cvar>

<cvar name="DCOM">
<summary>
<para>
  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>

<cvar name="DDEBUG">
<summary>
<para>
  List of debug tags to enable when compiling.
</para>
</summary>
</cvar>

<cvar name="DFLAGS">
<summary>
<para>
  General options that are passed to the D compiler.
</para>
</summary>
</cvar>

<cvar name="DLIB">
<summary>
<para>
  Name of the lib tool to use for D codes.
</para>
</summary>
</cvar>

<cvar name="DLIBCOM">
<summary>
<para>
  The command line to use when creating libraries.
</para>
</summary>
</cvar>

<cvar name="DLINK">
<summary>
<para>
  Name of the linker to use for linking systems including D sources.
</para>
</summary>
</cvar>

<cvar name="DLINKCOM">
<summary>
<para>
  The command line to use when linking systems including D sources.
</para>
</summary>
</cvar>

<cvar name="DLINKFLAGS">
<summary>
<para>
List of linker flags.
</para>
</summary>
</cvar>

<cvar name="DPATH">
<summary>
<para>
  List of paths to search for import modules.
</para>
</summary>
</cvar>

<cvar name="DVERSIONS">
<summary>
<para>
  List of version tags to enable when compiling.
</para>
</summary>
</cvar>

<cvar name="SHDC">
<summary>
<para>
  The name of the compiler to use when compiling D source
  destined to be in a shared objects.
</para>
</summary>
</cvar>

<cvar name="SHDCOM">
<summary>
<para>
  The command line to use when compiling code to be part of shared objects.
</para>
</summary>
</cvar>

<cvar name="SHDLINK">
<summary>
<para>
  The linker to use when creating shared objects for code bases
  include D sources.
</para>
</summary>
</cvar>

<cvar name="SHDLINKCOM">
<summary>
<para>
  The command line to use when generating shared objects.
</para>
</summary>
</cvar>

<cvar name="SHDLINKFLAGS">
<summary>
<para>
  The list of flags to use when generating a shared object.
</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>