Document ^^/ prefix

This commit is contained in:
Josh Holtrop 2022-02-27 16:05:28 -05:00
parent 6a10d68fac
commit b2d47cd439

View File

@ -835,6 +835,9 @@ files.
Source and target paths passed to a Builder (e.g. Program) can begin with "^/" Source and target paths passed to a Builder (e.g. Program) can begin with "^/"
to indicate that Rscons should expand those paths to be relative to the to indicate that Rscons should expand those paths to be relative to the
Environment's build root. Environment's build root.
If a source or target path passed to a Builder begins with "^^/", it is
expanded to be relative to the Rscons top-level build directory (but outside
the Environment's build root).
###> Construction Variables ###> Construction Variables
@ -882,7 +885,8 @@ The `target` parameter is the path to the output file or directory.
The `sources` parameter is the path or paths to the input file(s) to be used The `sources` parameter is the path or paths to the input file(s) to be used
by the builder. by the builder.
In the `target` and `sources` parameters, the user can explicitly refer to a In the `target` and `sources` parameters, the user can explicitly refer to a
path within the Environment's build root by beginning the path with "^/". path within the Environment's build root by beginning the path with "^/", or to
a path within the Rscons top-level built directory by beginning with "^^/".
The `vars` parameter is an optional Hash which can include construction The `vars` parameter is an optional Hash which can include construction
variables to be used for this build target. variables to be used for this build target.
Any construction variable values specified in this parameter will override Any construction variable values specified in this parameter will override