summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2004-02-08 14:54:08 (GMT)
committerSteven Knight <knight@baldmt.com>2004-02-08 14:54:08 (GMT)
commit00b13793fe88c9d101c3a73a6809e86298ed3186 (patch)
treeddfa6fe29059052420d8203bbb6d63ba0067d7ba /doc
parent18876ab2a7399e97fa1663b64d917fbfeba57cca (diff)
downloadSCons-00b13793fe88c9d101c3a73a6809e86298ed3186.zip
SCons-00b13793fe88c9d101c3a73a6809e86298ed3186.tar.gz
SCons-00b13793fe88c9d101c3a73a6809e86298ed3186.tar.bz2
Deprecate the overrides Builder() keyword argument in favor of specifying values directly as keyword arguments, like we do for other functions and methods.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.117
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index c5a1c4a..efa59ba 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -6170,18 +6170,21 @@ used for normal builds of normal target files,
which use the environment that was
used to call the Builder for the target file.)
-.IP overrides
-A dictionary of construction variables
-that will be set in the executing
-construction environment when this
-Builder is invoked.
+Any additional keyword arguments supplied
+when a Builder object is created
+(that is, when the Builder() function is called)
+will be set in the executing construction
+environment when the Builder object is called.
The canonical example here would be
to set a construction variable to
the repository of a source code system.
Any additional keyword arguments supplied
-when a Builder object is called
-will be associated with the target
+when a Builder
+.I object
+is called
+will only be associated with the target
+created by that particular Builder call
(and any other files built as a
result of the call).