diff options
| author | Mats Wichmann <mats@linux.com> | 2021-02-12 19:27:13 (GMT) |
|---|---|---|
| committer | Mats Wichmann <mats@linux.com> | 2021-02-26 18:31:37 (GMT) |
| commit | 1f50f1ad84d2dbe0f1b7411b9cfc834b570b6bed (patch) | |
| tree | f729cc5acc78583927a73fcf9d9debb37535877f /SCons/Defaults.xml | |
| parent | d469560de0fd76f5c64d4cf8f90aff1cb8ce25a0 (diff) | |
| download | SCons-1f50f1ad84d2dbe0f1b7411b9cfc834b570b6bed.zip SCons-1f50f1ad84d2dbe0f1b7411b9cfc834b570b6bed.tar.gz SCons-1f50f1ad84d2dbe0f1b7411b9cfc834b570b6bed.tar.bz2 | |
Update documentation for env.Append family [ci skip]
Try to be more descriptive of what happens in some special cases.
CPPDEFINES, LIBS, and the *PATH variables are mentioned.
Don't duplicate descriptions - AppendUnique, Prepend, PrependUnique
all point back to Append for the body of the description - the
idea is to avoid divergence. The same should happen for the
implementation, but that's a different PR.
Reformat examples with Black to continue getting example style
self-consistent within the docs (lots to go here!)
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'SCons/Defaults.xml')
| -rw-r--r-- | SCons/Defaults.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/SCons/Defaults.xml b/SCons/Defaults.xml index 6b034d9..8983ac0 100644 --- a/SCons/Defaults.xml +++ b/SCons/Defaults.xml @@ -87,7 +87,7 @@ of each definition in &cv-CPPDEFINES;. <cvar name="CPPDEFINES"> <summary> <para> -A platform independent specification of C preprocessor definitions. +A platform independent specification of C preprocessor macro definitions. The definitions will be added to command lines through the automatically-generated &cv-_CPPDEFFLAGS; construction variable (see above), @@ -159,7 +159,7 @@ env = Environment(CPPDEFINES={'B':2, 'A':None}) <cvar name="CPPDEFPREFIX"> <summary> <para> -The prefix used to specify preprocessor definitions +The prefix used to specify preprocessor macro definitions on the C compiler command line. This will be prepended to the beginning of each definition in the &cv-CPPDEFINES; construction variable @@ -171,7 +171,7 @@ when the &cv-_CPPDEFFLAGS; variable is automatically generated. <cvar name="CPPDEFSUFFIX"> <summary> <para> -The suffix used to specify preprocessor definitions +The suffix used to specify preprocessor macro definitions on the C compiler command line. This will be appended to the end of each definition in the &cv-CPPDEFINES; construction variable |