diff options
| author | William Deegan <bill@baddogconsulting.com> | 2022-08-14 18:02:18 -0700 |
|---|---|---|
| committer | William Deegan <bill@baddogconsulting.com> | 2022-08-14 18:02:18 -0700 |
| commit | 18745cfc5e75df8028682183097202f926e22134 (patch) | |
| tree | d0f7c25c74add033f5942fe4378805f5ba450e84 /SCons/Script | |
| parent | 7951e61b4eba59309624211a98a6a0e30e54740c (diff) | |
| download | scons-git-18745cfc5e75df8028682183097202f926e22134.tar.gz | |
add language with instructions what to do if options added by tools are being flagged as undefined. Per mwichmann's feedback
Diffstat (limited to 'SCons/Script')
| -rw-r--r-- | SCons/Script/Main.xml | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/SCons/Script/Main.xml b/SCons/Script/Main.xml index 70b9d18eb..e6eb4999c 100644 --- a/SCons/Script/Main.xml +++ b/SCons/Script/Main.xml @@ -947,12 +947,12 @@ SetOption('max_drift', 0) </scons_function> + <scons_function name="ValidateOptions"> <summary> <para> Check that all the options specified on the command line are either defined by SCons itself - or - defined by &f-link-AddOption;. + or defined by &f-link-AddOption;. </para> <para> If there are any command line options not defined. @@ -960,7 +960,12 @@ SetOption('max_drift', 0) status. </para> <para> - This function should only be called after the last &f-link-AddOption; call in your &SConscript; logic. + This function should only be called after the last &f-link-AddOption; call in your &SConscript; + logic. + </para> + <para> + Be aware that some tools call &f-link-AddOption;, if you are getting error messages for arguments + that they add, you will need to ensure that you load those tools before you call &f-ValidateOptions;. </para> </summary> </scons_function> |