src/engine/SCons/Tool/c++.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="cXX">
   8 <summary>
   9 Sets construction variables for generic POSIX C++ compilers.
  10 </summary>
  11 <sets>
  12 CXX
  13 CXXFLAGS
  14 CXXCOM
  15 SHCXX
  16 SHCXXFLAGS
  17 SHCXXCOM
  18 CPPDEFPREFIX
  19 CPPDEFSUFFIX
  20 INCPREFIX
  21 INCSUFFIX
  22 SHOBJSUFFIX
  23 OBJSUFFIX
  24 <!--STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME-->
  25 CXXFILESUFFIX
  26 </sets>
  27 <uses>
  28 CXXCOMSTR
  29 </uses>
  30 </tool>
  31
  32 <cvar name="CXX">
  33 <summary>
  34 The C++ compiler.
  35 </summary>
  36 </cvar>
  37
  38 <cvar name="CXXCOM">
  39 <summary>
  40 The command line used to compile a C++ source file to an object file.
  41 Any options specified in the &cv-link-CXXFLAGS; and
  42 &cv-link-CPPFLAGS; construction variables
  43 are included on this command line.
  44 </summary>
  45 </cvar>
  46
  47 <cvar name="CXXCOMSTR">
  48 <summary>
  49 The string displayed when a C++ source file
  50 is compiled to a (static) object file.
  51 If this is not set, then &cv-link-CXXCOM; (the command line) is displayed.
  52
  53 <example>
  54 env = Environment(CXXCOMSTR = "Compiling static object $TARGET")
  55 </example>
  56 </summary>
  57 </cvar>
  58
  59 <cvar name="CXXFLAGS">
  60 <summary>
  61 General options that are passed to the C++ compiler.
  62 By default, this includes the value of &cv-link-CCFLAGS;,
  63 so that setting &cv-CCFLAGS; affects both C and C++ compilation.
  64 If you want to add C++-specific flags,
  65 you must set or override the value of &cv-link-CXXFLAGS;.
  66 </summary>
  67 </cvar>
  68
  69 <cvar name="SHCXX">
  70 <summary>
  71 The C++ compiler used for generating shared-library objects.
  72 </summary>
  73 </cvar>
  74
  75 <cvar name="SHCXXCOM">
  76 <summary>
  77 The command line used to compile a C++ source file
  78 to a shared-library object file.
  79 Any options specified in the &cv-link-SHCXXFLAGS; and
  80 &cv-link-CPPFLAGS; construction variables
  81 are included on this command line.
  82 </summary>
  83 </cvar>
  84
  85 <cvar name="SHCXXCOMSTR">
  86 <summary>
  87 The string displayed when a C++ source file
  88 is compiled to a shared object file.
  89 If this is not set, then &cv-link-SHCXXCOM; (the command line) is displayed.
  90
  91 <example>
  92 env = Environment(SHCXXCOMSTR = "Compiling shared object $TARGET")
  93 </example>
  94 </summary>
  95 </cvar>
  96
  97 <cvar name="SHCXXFLAGS">
  98 <summary>
  99 Options that are passed to the C++ compiler
 100 to generate shared-library objects.
 101 </summary>
 102 </cvar>