Editing changes for textfile.xml and credit to Hartmut Goebel

git-svn-id: http://scons.tigris.org/svn/scons/trunk@4120 fdb21ef1-2011-0410-befe-b5e4ea1792b1

diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 94405dd81fbf706507d59345d26fc1e1abfb2959..846a57b85291490a5781046361470a9316a12822 100644 (file)
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -17,6 +17,10 @@ RELEASE X.X.X - XXX
 
     - An option name and aliases can now be specified as a tuple.
 
+  From Hartmut Goebel:
+
+    - Textfile builder.
+
   From Jim Hunziker:
 
     - Avoid adding -gphobos to a command line multiple times
@@ -50,7 +54,7 @@ RELEASE X.X.X - XXX
     - Restructure a test that occasionally hung so that the test would
       detect when it was stuck and fail instead.
 
-    - Add the Textfile and Substfile builders.
+    - Substfile builder.
 
   From Gary Oberbrunner:
 

diff --git a/src/engine/SCons/Tool/textfile.xml b/src/engine/SCons/Tool/textfile.xml
index d1026ec345c90e06244055f500f0366865275bf6..54e801c495c4ea11d90cdfcedea99476f403a52e 100644 (file)
--- a/src/engine/SCons/Tool/textfile.xml
+++ b/src/engine/SCons/Tool/textfile.xml
@@ -36,6 +36,7 @@ and &cv-TEXTFILESUFFIX; construction variables
 (the null string and <filename>.txt</filename> by default, respectively)
 are automatically added to the target if they are not already present.
 Examples:
+
 <example>
 # builds/writes foo.txt
 env.Textfile(target = 'foo.txt', source = ['Goethe', 42, 'Schiller'])
@@ -56,25 +57,25 @@ env.Textfile(target = 'concat',  # concatenate files with a marker between
 
 Results are:
 foo.txt
-  ....8<----
+  ....8&lt;----
   Goethe
   42
   Schiller
-  ....8<---- (no linefeed at the end)
+  ....8&lt;---- (no linefeed at the end)
 
 bar.txt:
-  ....8<----
+  ....8&lt;----
   lalala|*tanteratei
-  ....8<---- (no linefeed at the end)
+  ....8&lt;---- (no linefeed at the end)
 
-blog.txt
-  ....8<----
+blob.txt
+  ....8&lt;----
   lalala
   Goethe
   42
   Schiller
   tanteratei
-  ....8<---- (no linefeed at the end)
+  ....8&lt;---- (no linefeed at the end)
 </example>
 </summary>
 </builder>
@@ -108,7 +109,8 @@ are replaced by the corresponding value,
 which may be a Python callable function or a string.
 If a value is a function,
 it is first called (with no arguments) to produce a string.
-The string is &subst;-expanded and the result is substituted.
+The string is <emphasis>subst</emphasis>-expanded
+and the result replaces the key.
 
 <example>
 env = Environment(tools = ['default', 'textfile'])
@@ -125,7 +127,7 @@ bad_foo = {'$foo': '$foo', '$foobar': '$foobar'}
 env.Substfile('foo.in', SUBST_DICT = bad_foo)
 
 # PREDICTABLE - keys are applied longest first
-good_foo = ['$foobar': '$foobar', '$foo': '$foo']
+good_foo = [('$foobar', '$foobar'), ('$foo', '$foo')]
 env.Substfile('foo.in', SUBST_DICT = good_foo)
 
 # UNPREDICTABLE - one substitution could be futher expanded
@@ -185,7 +187,6 @@ the null string by default.
 <summary>
 The suffix used for &b-Substfile; file names,
 the null string by default.
-</example>
 </summary>
 </cvar>