summaryrefslogtreecommitdiff
path: root/SCons/Tool/textfile.xml
diff options
context:
space:
mode:
Diffstat (limited to 'SCons/Tool/textfile.xml')
-rw-r--r--SCons/Tool/textfile.xml13
1 files changed, 11 insertions, 2 deletions
diff --git a/SCons/Tool/textfile.xml b/SCons/Tool/textfile.xml
index a40fef295..b019c687d 100644
--- a/SCons/Tool/textfile.xml
+++ b/SCons/Tool/textfile.xml
@@ -35,6 +35,7 @@ Set &consvars; for the &b-Textfile; and &b-Substfile; builders.
<item>SUBSTFILESUFFIX</item>
<item>TEXTFILEPREFIX</item>
<item>TEXTFILESUFFIX</item>
+<item>FILE_ENCODING</item>
</sets>
<uses>
<item>SUBST_DICT</item>
@@ -64,7 +65,9 @@ The prefix and suffix specified by the &cv-link-TEXTFILEPREFIX;
and &cv-link-TEXTFILESUFFIX; &consvars;
(by default an empty string and <filename>.txt</filename>, respectively)
are automatically added to the target if they are not already present.
-By default file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
+</para>
+<para>
+By default the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
Examples:
</para>
@@ -127,6 +130,11 @@ are flattened. See also &b-link-Textfile;.
</para>
<para>
+By default the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
+Examples:
+</para>
+
+<para>
If a single source file name is specified and has a <filename>.in</filename> suffix,
the suffix is stripped and the remainder of the name is used as the default target name.
</para>
@@ -263,7 +271,8 @@ The suffix used for &b-link-Textfile; file names;
<cvar name="FILE_ENCODING">
<summary>
<para>
-File encoding. "utf-8" by default.
+File encoding used for files written by &b-link-Textfile; and &b-link-Substfile;. Set to "utf-8" by default.
+<emphasis>Added in version 4.5.0.</emphasis>
</para>
</summary>
</cvar>