From 77b7f15937bd601fe20f50938be6804ae5ab128b Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Wed, 27 May 2020 07:22:02 -0600 Subject: [PR #3671] fix typo; add missed file [ci skip] Sider detected a misspelled tag Failed to "add" one changed doc file, Defaults.xml. Added. Signed-off-by: Mats Wichmann --- SCons/Defaults.xml | 27 ++++++++++++++++----------- SCons/Environment.xml | 2 +- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/SCons/Defaults.xml b/SCons/Defaults.xml index bd41cdf..8f3fe12 100644 --- a/SCons/Defaults.xml +++ b/SCons/Defaults.xml @@ -572,20 +572,25 @@ searching the repositories. -Creates and returns the default &consenv; object. -The default &consenv; is used internally by SCons +Instantiates and returns the default &consenv; object. +The &defenv; is used internally by SCons in order to execute many of the global functions in this list -(i.e. those not called as methods of a specific -&consenv;), and to fetch source files transparently -from source code management systems. -The default environment is a singleton, so the keyword +(that is, those not called as methods of a specific &consenv;). +It is not mandatory to call &f-DefaultEnvironment;: +the &defenv; will be instantiated automatically when the +build phase begins if the function has not been called, +however calling it explicitly gives the opportunity to +affect and examine the contents of the &defenv;. + + +The &defenv; is a singleton, so the keyword arguments affect it only on the first call, on subsequent calls the already-constructed object is returned and -any arguments are ignored. -The default environment can be modified in the same way -as any &consenv;. -Modifying the &defenv; has no effect on the environment -constructed by a subsequent &f-Environment; call. +any keyword arguments are silently ignored. +The &defenv; can be modified after instantiation +in the same way as any &consenv;. +Modifying the &defenv; has no effect on the &consenv; +constructed by an &f-link-Environment; or &f-link-Clone; call. diff --git a/SCons/Environment.xml b/SCons/Environment.xml index bc1864f..fe7841a 100644 --- a/SCons/Environment.xml +++ b/SCons/Environment.xml @@ -905,7 +905,7 @@ if any of the sources will be directories that must be scanned on-disk for changes to files that aren't already specified in other Builder of function calls. -The *_factory arguments take a factory function that +The *_factory arguments take a factory function that &Command; will use to turn any sources or targets specified as strings into SCons Nodes. See the manpage section "Builder Objects" -- cgit v0.12