From 70b64467bf91b6a1ea1224f43de4d4f416d94799 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Tue, 1 Aug 2023 15:24:16 -0600 Subject: Further tweak user guide Help description [skip appveyor] Signed-off-by: Mats Wichmann --- doc/user/output.xml | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/doc/user/output.xml b/doc/user/output.xml index 3831088..7a63540 100644 --- a/doc/user/output.xml +++ b/doc/user/output.xml @@ -104,8 +104,8 @@ Type: 'scons program' to build the production program, multiple calls to the &f-link-Help; function, in which case the specified text(s) will be concatenated when displayed. - This allows you to define bits of help text together with - the corresponding feature, even if speread + This allows you to define fragments of help text together with + the corresponding feature, even if spread across multiple &SConscript; files. In this situation, the order in which the &SConscript; files are called @@ -117,11 +117,13 @@ Type: 'scons program' to build the production program, - Calling Help("text") will clobber - any help output associated with &f-link-AddOption; calls. - To preserve the help output from &AddOption;, - add the append=True keyword argument. - This also preserves the help for the &scons; command itself. + Calling Help("text") overwrites + the help text that otherwise would be collected from any + command-line options defined in &f-link-AddOption; calls. + To preserve the &AddOption; help text, + add the append=True keyword argument + when calling Help. + This also preserves the option help for the &scons; command itself. To preserve only the &AddOption; help, also add the local_only=True keyword argument. (This only matters the first time you call &Append;, -- cgit v0.12