SCons/Tool/cc.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 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  25
  26 <tool name="cc">
  27 <summary>
  28 <para>
  29 Sets construction variables for generic POSIX C compilers.
  30 </para>
  31 </summary>
  32 <sets>
  33 <item><!--_CCCOMCOM--></item>
  34 <item>FRAMEWORKS</item>
  35 <item>FRAMEWORKPATH</item>
  36 <item>CC</item>
  37 <item>CFLAGS</item>
  38 <item>CCFLAGS</item>
  39 <item>CCCOM</item>
  40 <item>SHCC</item>
  41 <item>SHCFLAGS</item>
  42 <item>SHCCFLAGS</item>
  43 <item>SHCCCOM</item>
  44 <item>CPPDEFPREFIX</item>
  45 <item>CPPDEFSUFFIX</item>
  46 <item>INCPREFIX</item>
  47 <item>INCSUFFIX</item>
  48 <item>SHOBJSUFFIX</item>
  49 <item><!--STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME--></item>
  50 <item>CFILESUFFIX</item>
  51  <item>CCDEPFLAGS</item>
  52 </sets>
  53 <uses>
  54 <item>PLATFORM</item>
  55 <item>CCCOMSTR</item>
  56 <item>SHCCCOMSTR</item>
  57 </uses>
  58 </tool>
  59
  60 <cvar name="CC">
  61 <summary>
  62 <para>
  63 The C compiler.
  64 </para>
  65 </summary>
  66 </cvar>
  67
  68 <cvar name="CCCOM">
  69 <summary>
  70 <para>
  71 The command line used to compile a C source file to a (static) object
  72 file.  Any options specified in the &cv-link-CFLAGS;, &cv-link-CCFLAGS; and
  73 &cv-link-CPPFLAGS; construction variables are included on this command line.
  74 See also &cv-link-SHCCCOM; for compiling to shared objects.
  75 </para>
  76 </summary>
  77 </cvar>
  78
  79 <cvar name="CCCOMSTR">
  80 <summary>
  81 <para>
  82 If set, the string displayed when a C source file
  83 is compiled to a (static) object file.
  84 If not set, then &cv-link-CCCOM; (the command line) is displayed.
  85 See also &cv-link-SHCCCOMSTR; for compiling to shared objects.
  86 </para>
  87
  88 <example_commands>
  89 env = Environment(CCCOMSTR = "Compiling static object $TARGET")
  90 </example_commands>
  91 </summary>
  92 </cvar>
  93
  94 <cvar name="CCFLAGS">
  95 <summary>
  96 <para>
  97 General options that are passed to the C and C++ compilers.
  98 See also &cv-link-SHCCFLAGS; for compiling to shared objects.
  99 </para>
 100 </summary>
 101 </cvar>
 102
 103 <cvar name="CFLAGS">
 104 <summary>
 105 <para>
 106 General options that are passed to the C compiler (C only; not C++).
 107 See also &cv-link-SHCFLAGS; for compiling to shared objects.
 108 </para>
 109 </summary>
 110 </cvar>
 111
 112 <cvar name="CPPFLAGS">
 113 <summary>
 114 <para>
 115 User-specified C preprocessor options.
 116 These will be included in any command that uses the C preprocessor,
 117 including not just compilation of C and C++ source files
 118 via the &cv-link-CCCOM;,
 119 &cv-link-SHCCCOM;,
 120 &cv-link-CXXCOM; and
 121 &cv-link-SHCXXCOM; command lines,
 122 but also the &cv-link-FORTRANPPCOM;,
 123 &cv-link-SHFORTRANPPCOM;,
 124 &cv-link-F77PPCOM; and
 125 &cv-link-SHF77PPCOM; command lines
 126 used to compile a Fortran source file,
 127 and the &cv-link-ASPPCOM; command line
 128 used to assemble an assembly language source file,
 129 after first running each file through the C preprocessor.
 130 Note that this variable does
 131 <emphasis>not</emphasis>
 132 contain
 133 <option>-I</option>
 134 (or similar) include search path options
 135 that scons generates automatically from &cv-link-CPPPATH;.
 136 See &cv-link-_CPPINCFLAGS;, below,
 137 for the variable that expands to those options.
 138 </para>
 139 </summary>
 140 </cvar>
 141
 142 <cvar name="CPPSUFFIXES">
 143 <summary>
 144 <para>
 145 The list of suffixes of files that will be scanned
 146 for C preprocessor implicit dependencies
 147 (#include lines).
 148 The default list is:
 149 </para>
 150
 151 <example_commands>
 152 [".c", ".C", ".cxx", ".cpp", ".c++", ".cc",
 153  ".h", ".H", ".hxx", ".hpp", ".hh",
 154  ".F", ".fpp", ".FPP",
 155  ".m", ".mm",
 156  ".S", ".spp", ".SPP"]
 157 </example_commands>
 158 </summary>
 159 </cvar>
 160
 161 <cvar name="SHCC">
 162 <summary>
 163 <para>
 164 The C compiler used for generating shared-library objects.
 165 See also &cv-link-CC; for compiling to static objects.
 166 </para>
 167 </summary>
 168 </cvar>
 169
 170 <cvar name="SHCCCOM">
 171 <summary>
 172 <para>
 173 The command line used to compile a C source file
 174 to a shared-library object file.
 175 Any options specified in the &cv-link-SHCFLAGS;,
 176 &cv-link-SHCCFLAGS; and
 177 &cv-link-CPPFLAGS; construction variables
 178 are included on this command line.
 179 See also &cv-link-CCCOM; for compiling to static objects.
 180 </para>
 181 </summary>
 182 </cvar>
 183
 184 <cvar name="SHCCCOMSTR">
 185 <summary>
 186 <para>
 187 If set, the string displayed when a C source file
 188 is compiled to a shared object file.
 189 If not set, then &cv-link-SHCCCOM; (the command line) is displayed.
 190 See also &cv-link-CCCOMSTR; for compiling to static objects.
 191 </para>
 192
 193 <example_commands>
 194 env = Environment(SHCCCOMSTR = "Compiling shared object $TARGET")
 195 </example_commands>
 196 </summary>
 197 </cvar>
 198
 199 <cvar name="SHCCFLAGS">
 200 <summary>
 201 <para>
 202 Options that are passed to the C and C++ compilers
 203 to generate shared-library objects.
 204 See also &cv-link-CCFLAGS; for compiling to static objects.
 205 </para>
 206 </summary>
 207 </cvar>
 208
 209 <cvar name="SHCFLAGS">
 210 <summary>
 211 <para>
 212 Options that are passed to the C compiler (only; not C++)
 213 to generate shared-library objects.
 214 See also &cv-link-CFLAGS; for compiling to static objects.
 215 </para>
 216 </summary>
 217 </cvar>
 218
 219 <cvar name="CCDEPFLAGS">
 220 <summary>
 221 <para>
 222 Options to pass to C or C++ compiler to generate list of dependency files.
 223 </para>
 224  <para>
 225   This is set only by compilers which support this functionality. (&t-link-gcc;, &t-link-clang;, and &t-link-msvc; currently)
 226  </para>
 227 </summary>
 228 </cvar>
 229
 230
 231 </sconsdoc>