From 78989ebb445af2c6462ae2bf05ffd588d76610e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Frings-F=C3=BCrst?= Date: Sat, 26 Jul 2014 16:31:27 +0200 Subject: Imported Upstream version 2.3.2 --- doc/generated/builders.gen | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) (limited to 'doc/generated/builders.gen') diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 41239d4..3d534b0 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -12,7 +12,7 @@ %variables-mod; ]> - + CFile() @@ -2137,11 +2137,10 @@ below, for more information. -The Substfile builder generates a single text file -by concatenating the source files. -Nested lists of sources are flattened. -$LINESEPARATOR is used to separate the source files; -see the description of Textfile for details. +The Substfile builder creates a single text file from another file or set of +files by concatenating them with $LINESEPARATOR and replacing text +using the $SUBST_DICT construction variable. Nested lists of source files +are flattened. See also Textfile. @@ -2159,20 +2158,18 @@ are automatically added to the target if they are not already present. If a construction variable named $SUBST_DICT is present, it may be either a Python dictionary or a sequence of (key,value) tuples. -If the former, -the dictionary is converted into a list of tuples in an arbitrary order, +If it is a dictionary it is converted into a list of tuples in an arbitrary order, so if one key is a prefix of another key or if one substitution could be further expanded by another subsitition, -it is unpredictible whether the expansion will occur. +it is unpredictable whether the expansion will occur. -Any occurences in the source of a key +Any occurrences of a key in the source 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 +If the value is a callable, it is called with no arguments to get a string. +Strings are subst-expanded and the result replaces the key. @@ -2278,7 +2275,7 @@ env.Tar('foo') The Textfile builder generates a single text file. The source strings constitute the lines; -nested lists of sources are flattened. +nested lists of sources are flattened. $LINESEPARATOR is used to separate the strings. @@ -2306,7 +2303,7 @@ env.Textfile(target = 'bar', LINESEPARATOR='|*') # nested lists are flattened automatically -env.Textfile(target = 'blob', +env.Textfile(target = 'blob', source = ['lalala', ['Goethe', 42 'Schiller'], 'tanteratei']) # files may be used as input by wraping them in File() -- cgit v1.2.3