Print this page
6205 onbld manuals should be declared as 1onbld
Reviewed by: Dan McDonald <danmcd@omniti.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/tools/cw/cw.1.man.txt
+++ new/usr/src/tools/cw/cw.1onbld.man.txt
1 -cw(1) User Commands cw(1)
1 +cw(1ONBLD) illumos Build Tools cw(1ONBLD)
2 2
3 3
4 4
5 5 NAME
6 6 cw - invoke one or more compilers with argument translation
7 7
8 8 SYNOPSIS
9 9 cw {-_cc|-_gcc|-_CC|-_g++} [options] [compiler args...]
10 10
11 11 DESCRIPTION
12 12 cw is a facility for invoking one or more compilers, providing
13 13 translation from Sun Studio arguments as appropriate. This allows the
14 14 use of arbitrary compilers without the need to alter large numbers of
15 15 makefiles. A mode called shadow compilation, the default, invokes two
16 16 different compilers so that warnings and errors may be obtained from
17 17 both. See SHADOW COMPILATION for details. This version of cw supports
18 18 Sun Studio 10 and 11 and gcc 3.4.3 as shipped in Solaris.
19 19
20 20 ARGUMENTS
21 21 Exactly one of the following arguments is required, and must appear
22 22 immediately following cw in the argument list:
23 23
24 24 -_cc
25 25 Select Sun Studio C (cc) as the primary compiler.
26 26
27 27 -_gcc
28 28 Select GNU C (gcc) as the primary compiler.
29 29
30 30 -_CC
31 31 Select Sun Studio C++ (CC) as the primary compiler.
32 32
33 33 -_g++
34 34 Select GNU C++ (g++) as the primary compiler.
35 35
36 36 OPTIONS
37 37 The following options are supported:
38 38
39 39 -_compiler
40 40 Do not invoke any compiler; instead, write to standard output the
41 41 full path to the primary compiler that would be invoked. If this
42 42 option is given, it must appear immediately following the compiler
43 43 selection argument, and all other options will be disregarded.
44 44
45 45 -_versions
46 46 Print the cw version, followed in turn by the path to and versions
47 47 of each compiler which would be invoked. If this option is given,
48 48 it must appear immediately following the compiler selection
49 49 argument, and all other options will be disregarded.
50 50
51 51 -_noecho
52 52 Normally, cw writes to standard error the actual compiler commands
53 53 invoked, each prefixed with '+'. This option suppresses these
54 54 messages.
55 55
56 56 -_cc=,-_gcc=,-_CC=,-g++=
57 57 Pass compiler-dependent options. See ARGUMENT TRANSLATION.
58 58
59 59 SHADOW COMPILATION
60 60 Unless otherwise directed by environment variables (see ENVIRONMENT),
61 61 cw will invoke both the compiler specified by its first argument
62 62 (primary) and a designated alternate compiler (shadow). The primary
63 63 compiler will be invoked with the arguments given to cw, translated as
64 64 described in ARGUMENT TRANSLATION. The secondary compiler will be
65 65 invoked in parallel with the primary (but see ENVIRONMENT); its
66 66 arguments will likewise be translated. However, the shadow compiler's
67 67 arguments will also be modified as follows:
68 68
69 69 1. If none of -c, -E, -P, or -S appears in the argument list (that is,
70 70 linking is attempted), the shadow compiler will not be invoked.
71 71 This is because the objects built with that compiler which would be
72 72 linked have been previously discarded.
73 73
74 74 2. If an option of the form -ofilename was provided, it will be
75 75 replaced by two options of the form -o tempfile.
76 76
77 77 3. If the option -o was provided, its following argument will be
78 78 replaced by tempfile.
79 79
80 80 4. If neither of the above options was provided, two options of the
81 81 form -o tempfile will be added to the end of the argument list used
82 82 to invoke the shadow compiler.
83 83
84 84 In all three cases, tempfile is the name of a temporary file which will
85 85 be removed by cw before it terminates.
86 86
87 87 When shadow compilation is in effect, cw writes to standard error each
88 88 compiler's standard error output following its argument list. Messages
89 89 from the two compilers will not be interleaved. If cw is used to
90 90 invoke the preprocessor and no output location is specified, cw will
91 91 write to standard output the primary compiler's standard output, and
92 92 the secondary compiler's standard output will be discarded.
93 93
94 94 Because the Studio compilers write intermediate objects to fixed
95 95 filenames in the current directory when instructed to compile and link
96 96 multiple source files via a single command line, it would be unsafe to
97 97 invoke more than one compiler in this fashion. Therefore cw does not
98 98 accept multiple source files unless the preprocessor is to be invoked.
99 99 An attempt to invoke cw in this manner will result in an error.
100 100
101 101 ARGUMENT TRANSLATION
102 102 The arguments provided to cw will be passed through to each compiler
103 103 invoked, altered as follows:
104 104
105 105 1. Options intended for cw itself are removed.
106 106
107 107 2. The shadow compiler's arguments are modified as described in SHADOW
108 108 COMPILATION so that its output is discarded.
109 109
110 110 3. If the compiler to be invoked is a GNU C or C++ compiler, a set of
111 111 default flags is added to the beginning of the argument list, and
112 112 the remaining arguments are translated to their closest appropriate
113 113 semantic equivalents and passed in the same order as their
114 114 counterparts given to cw. Arguments which begin with -_gcc= or
115 115 -_g++= will be passed in place with the leading portion removed.
116 116 Arguments which begin with -_cc= or -_CC= will be discarded. See
117 117 the comments at the head of usr/src/tools/cw/cw.c for a detailed
118 118 list of translations.
119 119
120 120 4. If the compiler to be invoked is a Studio C or C++ compiler, the
121 121 remaining arguments are passed unmodified and in the same order as
122 122 given to cw. Arguments which begin with -_cc= or -_CC= will be
123 123 passed in place with the leading portion removed. Arguments which
124 124 begin with -_gcc= or -_g++= will be discarded.
125 125
126 126 ENVIRONMENT
127 127 CW_NO_SHADOW
128 128 If this variable is set in the environment, invoke only the primary
129 129 compiler.
130 130
131 131 CW_SHADOW_SERIAL
132 132 If this variable is set in the environment, invoke the primary
133 133 compiler, wait for it to complete, then invoke the shadow compiler.
134 134 Normally the two compilers are invoked in parallel. If
135 135 CW_NO_SHADOW is set, this has no effect.
136 136
137 137 CW_NO_EXEC
138 138 If this variable is set in the environment, write the usual output
139 139 to standard error but do not actually invoke any compiler. This is
140 140 useful for debugging the translation engine.
141 141
142 142 CW_CC, CW_CPLUSPLUS
143 143 If these variables are set in the environment, they specify the
144 144 full pathname for the Studio C and C++ compilers, respectively.
145 145
146 146 CW_CC_DIR, CW_CPLUSPLUS_DIR, SPRO_VROOT, SPRO_ROOT, BUILD_TOOLS
147 147 If CW_CC or CW_CPLUSPLUS are not set, these variables define the
148 148 search path for Studio compilers as follows: If CW_CC_DIR is set,
149 149 the Studio C compiler in $CW_CC_DIR will be used. Likewise, if
150 150 CW_CPLUSPLUS_DIR is set, the Studio C++ compiler in
151 151 $CW_CPLUSPLUS_DIR will be used. Otherwise, if SPRO_VROOT is set,
152 152 the Studio C and C++ compilers in $SPRO_VROOT/bin will be used.
153 153 Otherwise, if SPRO_ROOT is set, the Studio C and C++ compilers in
154 154 $SPRO_ROOT/SS12/bin will be used. Otherwise, if BUILD_TOOLS is
155 155 set, the Studio C and C++ compilers in
156 156 $BUILD_TOOLS/SUNWspro/SS12/bin will be used. Otherwise, the Studio
157 157 compilers in a predefined default location will be used.
158 158
159 159 CW_GCC, CW_GPLUSPLUS
160 160 If these variables are set in the environment, they specify the
161 161 full pathname for the GNU C and C++ compilers, respectively.
162 162
163 163 CW_GCC_DIR, CW_GPLUSPLUS_DIR, GNU_ROOT
164 164 If CW_GCC or CW_GPLUSPLUS are not set, these variables alter the
165 165 search path for GNU compilers in a manner similar to that described
166 166 above for the Studio compilers. Specifically: If CW_GCC_DIR is
167 167 set, the GNU C compiler in $CW_GCC_DIR will be used. Likewise, if
168 168 CW_GPLUSPLUS_DIR is set, the GNU C++ compiler in $CW_GPLUSPLUS_DIR
169 169 will be used. Otherwise, if GNU_ROOT is set, the GNU C and C++
170 170 compilers in $GCC_ROOT/bin will be used. Otherwise, the GNU
171 171 compilers in a predefined default location will be used.
172 172
173 173 EXIT STATUS
174 174 The following exit status values are returned:
175 175
176 176 0 The primary compiler, and shadow compiler if invoked, both
177 177 completed successfully.
178 178
179 179 >0 A usage error occurred, or one or more compilers returned a nonzero
180 180 exit status.
181 181
182 182 BUGS
183 183 The translations provided for gcc are not always exact and in some
184 184 cases reflect local ON policy rather than actual equivalence.
|
↓ open down ↓ |
173 lines elided |
↑ open up ↑ |
185 185
186 186 Additional compiler types should be supported.
187 187
188 188 The translation engine is hacky.
189 189
190 190 SEE ALSO
191 191 cc(1), CC(1), gcc(1)
192 192
193 193
194 194
195 - 22 March 2010 cw(1)
195 + 22 March 2010 cw(1ONBLD)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX