Print this page
cw: don't shadow pure pre-processing
cw(1onbld): --shadow not --secondary
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/tools/cw/cw.1onbld.man.txt
+++ new/usr/src/tools/cw/cw.1onbld.man.txt
1 1 CW(1ONBLD) illumos Build Tools CW(1ONBLD)
2 2
3 3 NAME
4 4 cw - invoke one or more compilers with argument translation
5 5
6 6 SYNOPSIS
7 7 cw [-C] [--versions] [--noecho] --primary compiler
8 8 [--shadow compiler ...] -- compiler args ...
9 9
↓ open down ↓ |
9 lines elided |
↑ open up ↑ |
10 10 DESCRIPTION
11 11 cw is a facility for invoking one or more compilers, providing
12 12 translation from Sun style arguments as appropriate. This allows the use
13 13 of arbitrary compilers without the need to alter large numbers of
14 14 makefiles. A mode called shadow compilation invokes multiple compilers
15 15 so that warnings and errors may be obtained from both. See SHADOW
16 16 COMPILATION for details. This version of cw supports compilers with both
17 17 Sun Studio 12 and GCC-style command lines.
18 18
19 19 ARGUMENTS
20 - Both the --primary and --secondary parameters take a compiler
21 - specification. This is a comma-separated list of the form
22 - name,executable,style Where name is a name for the compiler, executable
23 - is the full path to the compiler executable, and style is the style of
24 - command-line options the compiler expects, either sun or gnu.
20 + Both the --primary and --shadow parameters take a compiler specification.
21 + This is a comma-separated list of the form name,executable,style Where
22 + name is a name for the compiler, executable is the full path to the
23 + compiler executable, and style is the style of command-line options the
24 + compiler expects, either sun or gnu.
25 25
26 26 --primary compiler
27 27 Specify the compiler to be used primarily (that which is used for
28 28 link-editing and pre-processing, and whos objects we deliver).
29 29
30 30 --shadow compiler
31 31 Specify a shadow compiler, which builds sources for the sake of
32 32 checking code quality and compatibility, but has its output
33 33 discarded.
34 34
35 35 --noecho
36 36 Do not echo the actual command line of any compilers invoked.
37 37
38 38 --versions
39 39 Request from each configured primary and shadow compiler its
40 40 version information.
41 41
42 42 -C The sources being compiled are C++. This is necessary as it
43 43 affects the translation of compiler arguments.
44 44
45 45 -- Arguments intended for the compilers themselves must be separated
46 46 from those of cw by a --.
47 47
48 48 -_name=
49 49
50 50 -_style=
51 51 Parameters intended for the compiler be guarded with options of
52 52 the form -_name= and -_style= Where name and style are those
53 53 passed to --primary and --shadow this allows certain flags to be
54 54 passed only to certain classes of compiler.
55 55
56 56 For historical reasons, the -_style= option is also translated
↓ open down ↓ |
22 lines elided |
↑ open up ↑ |
57 57 such that a style of sun may use the flag -_cc= and a style of
58 58 gnu may use the flag -_gcc=, and when the -C option is given and
59 59 C++ is in use the style of sun may use the flag -_CC= and the
60 60 style of gnu may use the flag -_g++=.
61 61
62 62 SHADOW COMPILATION
63 63 If --shadow compilers are specified cw will invoke shadow compiler, with
64 64 the outputs modified (as well as any translation for compiler style) as
65 65 follows:
66 66
67 - 1. If none of -c, -E, -P, or -S appears in the argument list (that is,
68 - linking is attempted), the shadow compilers will not be invoked.
69 - This is because the objects built with that compiler which would be
70 - linked have been previously discarded.
67 + 1. If neither of -c, -S appears in the argument list (that is, linking
68 + is attempted or only the pre-processor is invoked), the shadow
69 + compilers will not be invoked.
71 70
72 71 2. If the -o filename option was provided, with or without a separating
73 72 space, it will be replaced with -o tempfile
74 73
75 74 3. If the option -o was not provided, -o tempfile will be added to the
76 75 end of the argument list used to invoke the shadow compilers.
77 76 When shadow compilation is in effect, cw writes to standard error each
78 77 compiler's standard error output following its argument list. Messages
79 78 from the compilers will not be interleaved. If cw is used to invoke the
80 79 preprocessor and no output location is specified, cw will write to
81 - standard output the primary compiler's standard output, and the secondary
82 - compiler's standard output will be discarded.
80 + standard output the primary compiler's standard output.
83 81
84 82 Because the Sun compilers write intermediate objects to fixed filenames
85 83 in the current directory when instructed to compile and link multiple
86 84 source files via a single command line, it would be unsafe to invoke more
87 85 than one compiler in this fashion. Therefore cw does not accept multiple
88 86 source files unless the preprocessor is to be invoked. An attempt to
89 87 invoke cw in this manner will result in an error.
90 88
91 89 ARGUMENT TRANSLATION
92 90 If the compiler to be invoked is a GNU-style C or C++ compiler, a set of
93 91 default flags is added to the beginning of the argument list, and the
94 92 remaining arguments are translated to their closest appropriate semantic
95 93 equivalents and passed in the same order as their counterparts given to
96 94 cw. See the comments at the head of usr/src/tools/cw/cw.c for a detailed
97 95 list of translations.
98 96
99 97 ENVIRONMENT
100 98 CW_SHADOW_SERIAL
101 99 If this variable is set in the environment, invoke the primary
102 100 compiler, wait for it to complete, then invoke the shadow
103 101 compilers. Normally the primary and shadow compilers are invoked
104 102 in parallel.
105 103
106 104 CW_NO_EXEC
107 105 If this variable is set in the environment, write the usual
108 106 output to standard error but do not actually invoke any compiler.
109 107 This is useful for debugging the translation engine.
110 108
111 109 EXIT STATUS
112 110 The following exit status values are returned:
113 111
114 112 0 The primary compiler, and shadow compilers if invoked, both
115 113 completed successfully.
116 114
117 115 >0 A usage error occurred, or one or more compilers returned a
118 116 nonzero exit status.
119 117
120 118 SEE ALSO
121 119 cc(1), CC(1), gcc(1)
122 120
123 121 BUGS
124 122 The translations provided for gcc are not always exact and in some cases
125 123 reflect local policy rather than actual equivalence.
126 124
127 125 Additional compiler types should be supported.
128 126
129 127 The translation engine is hacky.
130 128
131 129 illumos February 10, 2018 illumos
↓ open down ↓ |
39 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX