Merge pull request #3520 from mwichmann/docfixes

Fixup some doc inconsistencies.

2 files changed, 38 insertions, 6 deletions

diff --git a/src/engine/SCons/Environment.xml b/src/engine/SCons/Environment.xml
index b1c2039..35e4bd8 100644
--- a/src/engine/SCons/Environment.xml
+++ b/src/engine/SCons/Environment.xml
@@ -2879,6 +2879,38 @@ function.
 </summary>
 </scons_function>
 
+<scons_function name="Split">
+<arguments>(arg)</arguments>
+<summary>
+<para>
+Returns a list of file names or other objects.
+If <varname>arg</varname> is a string,
+it will be split on strings of white-space characters
+within the string,
+making it easier to write long lists of file names.
+If <varname>arg</varname> is already a list,
+the list will be returned untouched.
+If <varname>arg</varname> is any other type of object,
+it will be returned as a list
+containing just the object.
+</para>
+
+<para>
+Example:
+</para>
+
+<example_commands>
+files = Split("f1.c f2.c f3.c")
+files = env.Split("f4.c f5.c f6.c")
+files = Split("""
+       f7.c
+       f8.c
+       f9.c
+""")
+</example_commands>
+</summary>
+</scons_function>
+
 <scons_function name="subst">
 <arguments signature="env">
 (input, [raw, target, source, conv])
diff --git a/src/engine/SCons/Script/SConscript.xml b/src/engine/SCons/Script/SConscript.xml
index 874c110..a1e0129 100644
--- a/src/engine/SCons/Script/SConscript.xml
+++ b/src/engine/SCons/Script/SConscript.xml
@@ -252,16 +252,16 @@ This specifies help text to be printed if the
 <option>-h</option>
 argument is given to
 &scons;.
-If 
+If
 &f-Help;
-is called multiple times, the text is appended together in the order that 
+is called multiple times, the text is appended together in the order that
 &f-Help;
-is called. With append set to False, any 
+is called. With append set to False, any
 &f-Help;
-text generated with 
+text generated with
 &f-AddOption;
 is clobbered. If append is True, the AddOption help is prepended to the help
-string, thus preserving the 
+string, thus preserving the
 <option>-h</option>
 message.
 </para>
@@ -393,7 +393,7 @@ A single script may be specified as a string;
 multiple scripts must be specified as a list
 (either explicitly or as created by
 a function like
-&f-Split;).
+&f-link-Split;).
 Examples:
 </para>
 <example_commands>