summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2023-05-08 12:55:27 -0600
committerMats Wichmann <mats@linux.com>2023-05-08 12:57:18 -0600
commitd723812004c1e88c5bfab37b454b7164f5b4ae00 (patch)
treeaeca6c949d8ceb3af8bd529fe6d2c7258ea66347
parent7923bb984986831f6696ae966e3297cce7e96316 (diff)
downloadscons-git-d723812004c1e88c5bfab37b454b7164f5b4ae00.tar.gz
Put back Builder entityref in UG add-method [skip appveyor]
Entity reference &Builder;s was turned to plain text in a few places. Restored, this time using existing pluralized entity name &Builders;. Also twiddled a little wording in same User Guide chapter. Signed-off-by: Mats Wichmann <mats@linux.com>
-rw-r--r--doc/user/add-method.xml17
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/user/add-method.xml b/doc/user/add-method.xml
index 7c59bf21f..179be95fd 100644
--- a/doc/user/add-method.xml
+++ b/doc/user/add-method.xml
@@ -32,9 +32,14 @@ Copyright The SCons Foundation
The &f-link-AddMethod; function is used to add a method
to an environment. It is typically used to add a "pseudo-builder,"
a function that looks like a &Builder; but
- wraps up calls to multiple other Builders
+ wraps up calls to multiple other &Builders;
or otherwise processes its arguments
- before calling one or more Builders.
+ before calling one or more &Builders;.
+
+ </para>
+
+ <para>
+
In the following example,
we want to install the program into the standard
<filename>/usr/bin</filename> directory hierarchy,
@@ -70,11 +75,11 @@ int main() { printf("Hello, world!\n"); }
<para>
- A pseudo-builder is useful because it provides more flexibility
- in parsing arguments than you can get with a standard &Builder;.
+ A pseudo-builder is useful because it gives you more flexibility
+ parsing arguments than you can get with a standard &Builder;.
The next example shows a pseudo-builder with a
- named argument that modifies the filename, and a separate argument
- for the resource file (rather than having the builder figure it out
+ named argument that modifies the filename, and a separate optional
+ argument for a resource file (rather than having the builder figure it out
by file extension). This example also demonstrates using the global
&AddMethod; function to add a method to the global Environment class,
so it will be available in all subsequently created environments.