summaryrefslogtreecommitdiffstats
path: root/SCons/Defaults.xml
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2021-06-13 23:01:33 (GMT)
committerWilliam Deegan <bill@baddogconsulting.com>2021-06-13 23:01:33 (GMT)
commit76c47082b927ea9dffdfc1ee4d38efbcef058ad1 (patch)
treecad263f6e26f8590f222c454a3a1c5d4e3a13447 /SCons/Defaults.xml
parentb9ac13dde74de190a0d762acfc4c083cc47b087c (diff)
downloadSCons-76c47082b927ea9dffdfc1ee4d38efbcef058ad1.zip
SCons-76c47082b927ea9dffdfc1ee4d38efbcef058ad1.tar.gz
SCons-76c47082b927ea9dffdfc1ee4d38efbcef058ad1.tar.bz2
[ci skip] updated docs per mwichmann's feedback
Diffstat (limited to 'SCons/Defaults.xml')
-rw-r--r--SCons/Defaults.xml30
1 files changed, 17 insertions, 13 deletions
diff --git a/SCons/Defaults.xml b/SCons/Defaults.xml
index 34fd371..2d6ba10 100644
--- a/SCons/Defaults.xml
+++ b/SCons/Defaults.xml
@@ -25,19 +25,23 @@ See its __doc__ string for a discussion of the format.
<cvar name ="_concat">
<summary>
-<para>
-A function used to produce variables like &cv-link-_CPPINCFLAGS;. It takes
-four or five
-arguments: a prefix to concatenate onto each element, a list of
-elements, a suffix to concatenate onto each element, an environment
-for variable interpolation, an optional function that will be
-called to transform the list before concatenation, affect_signature which will wrap non-empty returned value with
- $( and $) to indicate the contents should not affect the signature of the generated command line.
-</para>
-
-<example_commands>
-env['_CPPINCFLAGS'] = '${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, affect_signature=False)}',
-</example_commands>
+ <para>
+ A function used to produce variables like &cv-link-_CPPINCFLAGS;. It takes
+ four mandatory arguments, and up to 4 additional optional arguments:
+ 1) a prefix to concatenate onto each element,
+ 2) a list of elements,
+ 3) a suffix to concatenate onto each element,
+ 4) an environment for variable interpolation,
+ 5) an optional function that will be called to transform the list before concatenation,
+ 6) an optionally specified target (Can use TARGET),
+ 7) an optionally specified source (Can use SOURCE),
+ 8) optional affect_signature flag which will wrap non-empty returned value with $( and $) to indicate the contents
+ should not affect the signature of the generated command line.
+ </para>
+
+ <example_commands>
+ env['_CPPINCFLAGS'] = '${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE, affect_signature=False)}'
+ </example_commands>
</summary>
</cvar>