summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/c++.xml
blob: c10438aaa427147ee6332ed8d8a2ae47fc2e7553 (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
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2001 - 2019 The SCons Foundation

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 http://www.scons.org/dbxsd/v1.0/scons.xsd">

<tool name="cXX">
<summary>
<para>
Sets construction variables for generic POSIX C++ compilers.
</para>
</summary>
<sets>
<item>CXX</item>
<item>CXXFLAGS</item>
<item>CXXCOM</item>
<item>SHCXX</item>
<item>SHCXXFLAGS</item>
<item>SHCXXCOM</item>
<item>CPPDEFPREFIX</item>
<item>CPPDEFSUFFIX</item>
<item>INCPREFIX</item>
<item>INCSUFFIX</item>
<item>SHOBJSUFFIX</item>
<item>OBJSUFFIX</item>
<item><!--STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME--></item>
<item>CXXFILESUFFIX</item>
</sets>
<uses>
<item>CXXCOMSTR</item>
</uses>
</tool>

<cvar name="CXX">
<summary>
<para>
The C++ compiler.
</para>
</summary>
</cvar>

<cvar name="CXXCOM">
<summary>
<para>
The command line used to compile a C++ source file to an object file.
Any options specified in the &cv-link-CXXFLAGS; and
&cv-link-CPPFLAGS; construction variables
are included on this command line.
</para>
</summary>
</cvar>

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

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

<cvar name="CXXFLAGS">
<summary>
<para>
General options that are passed to the C++ compiler.
By default, this includes the value of &cv-link-CCFLAGS;,
so that setting &cv-CCFLAGS; affects both C and C++ compilation.
If you want to add C++-specific flags,
you must set or override the value of &cv-link-CXXFLAGS;.
</para>
</summary>
</cvar>

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

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

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

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

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

</sconsdoc>