diff options
author | Mats Wichmann <mats@linux.com> | 2019-05-08 16:32:44 (GMT) |
---|---|---|
committer | Mats Wichmann <mats@linux.com> | 2019-05-14 16:48:07 (GMT) |
commit | 2792dbd6420f59b26d105c7375e016231a2bd88c (patch) | |
tree | 5b2d30cd414ca653fcb769cdaa860ddef0fb0b30 /doc/man | |
parent | b47b5c7e6e293d353e944ebdce24345c51a88111 (diff) | |
download | SCons-2792dbd6420f59b26d105c7375e016231a2bd88c.zip SCons-2792dbd6420f59b26d105c7375e016231a2bd88c.tar.gz SCons-2792dbd6420f59b26d105c7375e016231a2bd88c.tar.bz2 |
Update docs for parse_flags keywords
The somewhat poorly named parse_flags keyword args actually work like
the MergeFlags method - don't just split like the ParseFlags method,
but do the merging as well. Tweak the docs and add a reference to
env.MergeFlags.
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/scons.xml | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 9172b15..542ac9d 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -2043,7 +2043,7 @@ env['BAR'] = 'bar' construction variables may also be set or modified by the <emphasis>parse_flags</emphasis> keyword argument, which applies the -<emphasis role="bold">ParseFlags</emphasis> +&f-link-env-MergeFlags; method (described below) to the argument value after all other processing is completed. This is useful either if the exact content of the flags is unknown @@ -2051,7 +2051,7 @@ This is useful either if the exact content of the flags is unknown or if the flags are distributed to a number of construction variables.</para> <literallayout class="monospaced"> -env = Environment(parse_flags = '-Iinclude -DEBUG -lm') +env = Environment(parse_flags='-Iinclude -DEBUG -lm') </literallayout> <para>This example adds 'include' to @@ -2439,10 +2439,14 @@ see the descriptions of these variables, below, for more information.)</para> <para>It is also possible to use the <emphasis>parse_flags</emphasis> -keyword argument in an override:</para> +keyword argument in an override, +to merge command-line style arguments +into the appropriate construction variables +(see &f-link-env-MergeFlags;). +</para> <literallayout class="monospaced"> -env = Program('hello', 'hello.c', parse_flags = '-Iinclude -DEBUG -lm') +env = Program('hello', 'hello.c', parse_flags='-Iinclude -DEBUG -lm') </literallayout> <para>This example adds 'include' to |