diff options
| author | Mats Wichmann <mats@linux.com> | 2022-12-06 12:02:15 -0700 |
|---|---|---|
| committer | Mats Wichmann <mats@linux.com> | 2022-12-06 12:17:03 -0700 |
| commit | a0d9e457e835ecb4f975d8b9e130726b7a9f06bd (patch) | |
| tree | 5213103c77d923bb1be0741947be5c588775c0ca /SCons/Script | |
| parent | 64353b2f48bda9610816bafd6129c2cc12cd4a9d (diff) | |
| download | scons-git-a0d9e457e835ecb4f975d8b9e130726b7a9f06bd.tar.gz | |
Manpage tweaking [skip appveyor]
* Reworded the section on --experimental - separate when the two current
features were made available, and when --experimental itself was added.
* Reworded in GetOption
* Changed tags on a few options
* Use entity forms in more places (Python -> &Python;, SConscript ->
&SConscript; etc.)
* Make changed/added notifications more consistent with what Sphinx
produces for the API docs (:versionadded: and :versionchanged: markup)
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'SCons/Script')
| -rw-r--r-- | SCons/Script/Main.xml | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/SCons/Script/Main.xml b/SCons/Script/Main.xml index cd4cc1add..fbb90fd07 100644 --- a/SCons/Script/Main.xml +++ b/SCons/Script/Main.xml @@ -316,18 +316,22 @@ atexit.register(print_build_failures) </arguments> <summary> <para> -This function provides a way to query the value of -options which can be set via the command line or using the -&f-link-SetOption; function. +Query the value of settable options which may have been set +on the command line, or by using the &f-link-SetOption; function. +The value of the option is returned in a type matching how the +option was declared - see the documentation for the +corresponding command line option for information about each specific +option. </para> + <para> <parameter>name</parameter> can be an entry from the following table, which shows the corresponding command line arguments that could affect the value. <parameter>name</parameter> can be also be the destination variable name from a project-specific option added using the -&f-link-AddOption; function, as long as the addition -happens prior to the &f-GetOption; call in the SConscript files. +&f-link-AddOption; function, as long as that addition has been +processed prior to the &f-GetOption; call in the &SConscript; files. </para> <informaltable rowsep="1" colsep="1" frame="topbot"> @@ -552,12 +556,6 @@ happens prior to the &f-GetOption; call in the SConscript files. </tbody> </tgroup> </informaltable> - -<para> -See the documentation for the -corresponding command line option for information about each specific -option. -</para> </summary> </scons_function> |