From 18745cfc5e75df8028682183097202f926e22134 Mon Sep 17 00:00:00 2001
From: William Deegan <bill@baddogconsulting.com>
Date: Sun, 14 Aug 2022 18:02:18 -0700
Subject: add language with instructions what to do if options added by tools
 are being flagged as undefined. Per mwichmann's feedback

---
 SCons/Script/Main.xml       | 11 ++++++++---
 doc/generated/functions.gen | 10 +++++++---
 2 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/SCons/Script/Main.xml b/SCons/Script/Main.xml
index 70b9d18..e6eb499 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>
diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen
index 03afa05..fd6c44b 100644
--- a/doc/generated/functions.gen
+++ b/doc/generated/functions.gen
@@ -4389,8 +4389,7 @@ the tool object, previously it did not return
     <term><replaceable>env</replaceable>.<methodname>ValidateOptions</methodname>()</term>
     <listitem><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.
@@ -4398,7 +4397,12 @@ the tool object, previously it did not return
                 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>
         </listitem>
   </varlistentry>
-- 
cgit v0.12