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