diff options
| author | Mats Wichmann <mats@linux.com> | 2020-01-07 16:36:47 (GMT) |
|---|---|---|
| committer | Mats Wichmann <mats@linux.com> | 2020-01-14 13:51:15 (GMT) |
| commit | 44e28045d9a4a0ee64b40ce4b469fd461df885bb (patch) | |
| tree | 57e95238a859ac6acf07bbf6506d74bda40c817b /doc/user/output.xml | |
| parent | 0ab03698067fe6e6fc0a3e245a0a5d42f20960c6 (diff) | |
| download | SCons-44e28045d9a4a0ee64b40ce4b469fd461df885bb.zip SCons-44e28045d9a4a0ee64b40ce4b469fd461df885bb.tar.gz SCons-44e28045d9a4a0ee64b40ce4b469fd461df885bb.tar.bz2 | |
docs: refer *COM* and SH*COM* to each other [ci skip]
[fixes #2565] Object code intended for use in a shared library may need
different compilation options than object code not intended for such
use. When SCons tools recognize this need they define parallel sets
of variables, such that for FOO there is both FOOCOM and SHFOOCOM,
FOOCOMSTR and SHFOOCOMSTR, etc. Refer such pairs to each other.
Issue 2565 described a case where a user did not realize they needed to
use SHCXXCOMSTR to affect the output for certain C++-compiled objects.
The discussion concluded this was just a doc fix.
Some examination turned up cases of this in docs for the C compiler,
C++ compiler, D compiler, Fortran compiler and linker modules, seemed
better to just hit all of those.
I would have preferred to move the pairs together into a single entry
but it seems the scons doc markup doesn't support this kind of usage -
a <cvar> can take only a single name attribute, and uses it to
generate tags, etc. so there would have been a ton of surgery
needed to implement that way.
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/user/output.xml')
| -rw-r--r-- | doc/user/output.xml | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/user/output.xml b/doc/user/output.xml index f9e1a98..d1082a9 100644 --- a/doc/user/output.xml +++ b/doc/user/output.xml @@ -47,7 +47,7 @@ <para> A key aspect of creating a usable build configuration - is providing good output from the build + is providing useful output from the build so its users can readily understand what the build is doing and get information about how to control the build. @@ -355,6 +355,17 @@ cc -o foo.o -c foo.c cc -o foo foo.o </screen> + <para> + + A gentle reminder here: many of the commands for building come in + pairs, depending on whether the intent is to build an object for + use in a shared library or not. The command strings mirror this, + so it may be necessary to set, for example, both + <envar>CCCOMSTR</envar> and <envar>SHCCCOMSTR</envar> + to get the desired results. + + </para> + </section> <section> |