SCons/Tool/DCommon.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 __COPYRIGHT__
   4
   5 This file is processed by the bin/SConsDoc.py module.
   6 See its __doc__ string for a discussion of the format.
   7 -->
   8
   9 <!DOCTYPE sconsdoc [
  10         <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  11         %scons;
  12         <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  13         %builders-mod;
  14         <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  15         %functions-mod;
  16         <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  17         %tools-mod;
  18         <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  19         %variables-mod;
  20         ]>
  21
  22 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  23           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  24           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd">
  25
  26 <cvar name="DC">
  27 <summary>
  28 <para>
  29 The D compiler to use.
  30 See also &cv-link-SHDC; for compiling to shared objects.
  31 </para>
  32 </summary>
  33 </cvar>
  34
  35 <cvar name="DCOM">
  36 <summary>
  37 <para>
  38 The command line used to compile a D file to an object file.
  39 Any options specified in the &cv-link-DFLAGS; construction variable
  40 is included on this command line.
  41 See also &cv-link-SHDCOM; for compiling to shared objects.
  42 </para>
  43 </summary>
  44 </cvar>
  45
  46 <cvar name="DCOMSTR">
  47 <summary>
  48 <para>
  49 If set, the string displayed when a D source file
  50 is compiled to a (static) object file.
  51 If not set, then &cv-link-DCOM; (the command line) is displayed.
  52 See also &cv-link-SHDCOMSTR; for compiling to shared objects.
  53 </para>
  54 </summary>
  55 </cvar>
  56
  57 <cvar name="DDEBUG">
  58 <summary>
  59 <para>
  60 List of debug tags to enable when compiling.
  61 </para>
  62 </summary>
  63 </cvar>
  64
  65 <cvar name="DDEBUGPREFIX">
  66 <summary>
  67 <para>
  68 DDEBUGPREFIX.
  69 </para>
  70 </summary>
  71 </cvar>
  72
  73 <cvar name="DDEBUGSUFFIX">
  74 <summary>
  75 <para>
  76 DDEBUGSUFFIX.
  77 </para>
  78 </summary>
  79 </cvar>
  80
  81 <cvar name="DFILESUFFIX">
  82 <summary>
  83 <para>
  84 DFILESUFFIX.
  85 </para>
  86 </summary>
  87 </cvar>
  88
  89 <cvar name="DFLAGPREFIX">
  90 <summary>
  91 <para>
  92 DFLAGPREFIX.
  93 </para>
  94 </summary>
  95 </cvar>
  96
  97 <cvar name="DFLAGS">
  98 <summary>
  99 <para>
 100 General options that are passed to the D compiler.
 101 </para>
 102 </summary>
 103 </cvar>
 104
 105 <cvar name="DFLAGSUFFIX">
 106 <summary>
 107 <para>
 108 DFLAGSUFFIX.
 109 </para>
 110 </summary>
 111 </cvar>
 112
 113 <cvar name="DINCSUFFIX">
 114 <summary>
 115 <para>
 116 DLIBFLAGSUFFIX.
 117 </para>
 118 </summary>
 119 </cvar>
 120
 121 <cvar name="DINCPREFIX">
 122 <summary>
 123 <para>
 124 DINCPREFIX.
 125 </para>
 126 </summary>
 127 </cvar>
 128
 129 <cvar name="DLIB">
 130 <summary>
 131 <para>
 132 Name of the lib tool to use for D codes.
 133 </para>
 134 </summary>
 135 </cvar>
 136
 137 <cvar name="DLIBCOM">
 138 <summary>
 139 <para>
 140 The command line to use when creating libraries.
 141 </para>
 142 </summary>
 143 </cvar>
 144
 145 <cvar name="DLIBDIRPREFIX">
 146 <summary>
 147 <para>
 148 DLIBLINKPREFIX.
 149 </para>
 150 </summary>
 151 </cvar>
 152
 153 <cvar name="DLIBDIRSUFFIX">
 154 <summary>
 155 <para>
 156 DLIBLINKSUFFIX.
 157 </para>
 158 </summary>
 159 </cvar>
 160
 161 <cvar name="DLIBFLAGSUFFIX">
 162 <summary>
 163 <para>
 164 DLIBFLAGSUFFIX.
 165 </para>
 166 </summary>
 167 </cvar>
 168
 169 <cvar name="DLIBFLAGPREFIX">
 170 <summary>
 171 <para>
 172 DLIBFLAGPREFIX.
 173 </para>
 174 </summary>
 175 </cvar>
 176
 177 <cvar name="DLIBLINKPREFIX">
 178 <summary>
 179 <para>
 180 DLIBLINKPREFIX.
 181 </para>
 182 </summary>
 183 </cvar>
 184
 185 <cvar name="DLIBLINKSUFFIX">
 186 <summary>
 187 <para>
 188 DLIBLINKSUFFIX.
 189 </para>
 190 </summary>
 191 </cvar>
 192
 193 <cvar name="DLINK">
 194 <summary>
 195 <para>
 196 Name of the linker to use for linking systems including D sources.
 197 See also &cv-link-SHDLINK; for linking shared objects.
 198 </para>
 199 </summary>
 200 </cvar>
 201
 202 <cvar name="DLINKCOM">
 203 <summary>
 204 <para>
 205 The command line to use when linking systems including D sources.
 206 See also &cv-link-SHDLINKCOM; for linking shared objects.
 207 </para>
 208 </summary>
 209 </cvar>
 210
 211 <cvar name="DLINKFLAGS">
 212 <summary>
 213 <para>
 214 List of linker flags.
 215 See also &cv-link-SHDLINKFLAGS; for linking shared objects.
 216 </para>
 217 </summary>
 218 </cvar>
 219
 220 <cvar name="DLINKFLAGSUFFIX">
 221 <summary>
 222 <para>
 223 DLINKFLAGSUFFIX.
 224 </para>
 225 </summary>
 226 </cvar>
 227
 228 <cvar name="DLINKFLAGPREFIX">
 229 <summary>
 230 <para>
 231 DLINKFLAGPREFIX.
 232 </para>
 233 </summary>
 234 </cvar>
 235
 236 <cvar name="DPATH">
 237 <summary>
 238 <para>
 239   List of paths to search for import modules.
 240 </para>
 241 </summary>
 242 </cvar>
 243
 244 <cvar name="DRPATHPREFIX">
 245 <summary>
 246 <para>
 247 DRPATHPREFIX.
 248 </para>
 249 </summary>
 250 </cvar>
 251
 252 <cvar name="DRPATHSUFFIX">
 253 <summary>
 254 <para>
 255 DRPATHSUFFIX.
 256 </para>
 257 </summary>
 258 </cvar>
 259
 260 <cvar name="DVERPREFIX">
 261 <summary>
 262 <para>
 263 DVERPREFIX.
 264 </para>
 265 </summary>
 266 </cvar>
 267
 268 <cvar name="DVERSIONS">
 269 <summary>
 270 <para>
 271 List of version tags to enable when compiling.
 272 </para>
 273 </summary>
 274 </cvar>
 275
 276 <cvar name="DVERSUFFIX">
 277 <summary>
 278 <para>
 279 DVERSUFFIX.
 280 </para>
 281 </summary>
 282 </cvar>
 283
 284 <cvar name="SHDC">
 285 <summary>
 286 <para>
 287 The name of the compiler to use when compiling D source
 288 destined to be in a shared objects.
 289 See also &cv-link-DC; for compiling to static objects.
 290 </para>
 291 </summary>
 292 </cvar>
 293
 294 <cvar name="SHDCOM">
 295 <summary>
 296 <para>
 297 The command line to use when compiling code to be part of shared objects.
 298 See also &cv-link-DCOM; for compiling to static objects.
 299 </para>
 300 </summary>
 301 </cvar>
 302
 303 <cvar name="SHDCOMSTR">
 304 <summary>
 305 <para>
 306 If set, the string displayed when a D source file
 307 is compiled to a (shared) object file.
 308 If not set, then &cv-link-SHDCOM; (the command line) is displayed.
 309 See also &cv-link-DCOMSTR; for compiling to static objects.
 310 </para>
 311 </summary>
 312 </cvar>
 313
 314
 315 <cvar name="SHDLIBVERSIONFLAGS">
 316 <summary>
 317 <para>
 318 Extra flags added to &cv-link-SHDLINKCOM; when building versioned
 319 &b-link-SharedLibrary;. These flags are only used when &cv-link-SHLIBVERSION; is
 320 set.
 321 </para>
 322 </summary>
 323 </cvar>
 324
 325 <cvar name="SHDLINK">
 326 <summary>
 327 <para>
 328 The linker to use when creating shared objects for code bases
 329 include D sources.
 330 See also &cv-link-DLINK; for linking static objects.
 331 </para>
 332 </summary>
 333 </cvar>
 334
 335 <cvar name="SHDLINKCOM">
 336 <summary>
 337 <para>
 338 The command line to use when generating shared objects.
 339 See also &cv-link-DLINKCOM; for linking static objects.
 340 </para>
 341 </summary>
 342 </cvar>
 343
 344 <cvar name="SHDLINKFLAGS">
 345 <summary>
 346 <para>
 347 The list of flags to use when generating a shared object.
 348 See also &cv-link-DLINKFLAGS; for linking static objects.
 349 </para>
 350 </summary>
 351 </cvar>
 352
 353
 354 <builder name="ProgramAllAtOnce">
 355 <summary>
 356   <para>
 357     Builds an executable from D sources without first creating individual
 358     objects for each file.
 359   </para>
 360   <para>
 361     D sources can be compiled file-by-file as C and C++ source are, and
 362     D is integrated into the &scons; Object and Program builders for
 363     this model of build. D codes can though do whole source
 364     meta-programming (some of the testing frameworks do this). For this
 365     it is imperative that all sources are compiled and linked in a single
 366     call to the D compiler. This builder serves that purpose.
 367   </para>
 368   <example_commands>
 369     env.ProgramAllAtOnce('executable', ['mod_a.d, mod_b.d', 'mod_c.d'])
 370   </example_commands>
 371   <para>
 372     This command will compile the modules mod_a, mod_b, and mod_c in a
 373     single compilation process without first creating object files for
 374     the modules. Some of the D compilers will create executable.o others
 375     will not.
 376   </para>
 377 </summary>
 378 </builder>
 379
 380 </sconsdoc>