summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Tool/cc.xml
blob: fb688adefeb68ea77cd88652928fcebb1cac0bd0 (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
<!-- __COPYRIGHT__ -->
<tool name="cc">
<summary>
XXX
</summary>
</tool>

<cvar name="CC">
<summary>
The C compiler.
</summary>
</cvar>

<cvar name="CCCOM">
<summary>
The command line used to compile a C source file to a (static) object file.
Any options specified in the &cv-CCFLAGS; and &cv-CPPFLAGS; construction variables
are included on this command line.
</summary>
</cvar>

<cvar name="CCCOMSTR">
<summary>
The string displayed when a C source file
is compiled to a (static) object file.
If this is not set, then &cv-CCCOM; (the command line) is displayed.

<example>
env = Environment(CCCOMSTR = "Compiling static object $TARGET")
</example>
</summary>
</cvar>

<cvar name="CCFLAGS">
<summary>
General options that are passed to the C compiler.
</summary>
</cvar>

<cvar name="CPPFLAGS">
<summary>
User-specified C preprocessor options.
These will be included in any command that uses the C preprocessor,
including not just compilation of C and C++ source files
via the &cv-CCCOM;, &cv-SHCCCOM;, &cv-CXXCOM; and &cv-SHCXXCOM; command lines,
but also the &cv-FORTRANPPCOM;, &cv-SHFORTRANPPCOM;,
&cv-F77PPCOM; and &cv-SHF77PPCOM; command lines
used to compile a Fortran source file,
and the &cv-ASPPCOM; command line
used to assemble an assembly language source file,
after first running each file through the C preprocessor.
Note that this variable does
<emphasis>not</emphasis>
contain
<option>-I</option>
(or similar) include search path options
that scons generates automatically from &cv-CPPPATH;.
See &cv-link-_CPPINCFLAGS;, below,
for the variable that expands to those options.
</summary>
</cvar>

<cvar name="CPPSUFFIXES">
<summary>
The list of suffixes of files that will be scanned
for C preprocessor implicit dependencies
(#include lines).
The default list is:

<example>
[".c", ".C", ".cxx", ".cpp", ".c++", ".cc",
 ".h", ".H", ".hxx", ".hpp", ".hh",
 ".F", ".fpp", ".FPP",
 ".S", ".spp", ".SPP"]
</example>
</summary>
</cvar>

<cvar name="SHCC">
<summary>
The C compiler used for generating shared-library objects.
</summary>
</cvar>

<cvar name="SHCCCOM">
<summary>
The command line used to compile a C source file
to a shared-library object file.
Any options specified in the &cv-SHCCFLAGS; and &cv-CPPFLAGS; construction variables
are included on this command line.
</summary>
</cvar>

<cvar name="SHCCCOMSTR">
<summary>
The string displayed when a C source file
is compiled to a shared object file.
If this is not set, then &cv-SHCCCOM; (the command line) is displayed.

<example>
env = Environment(SHCCCOMSTR = "Compiling shared object $TARGET")
</example>
</summary>
</cvar>

<cvar name="SHCCFLAGS">
<summary>
Options that are passed to the C compiler
to generate shared-library objects.
</summary>
</cvar>