summaryrefslogtreecommitdiffstats
path: root/src/engine
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2019-09-25 18:53:51 (GMT)
committerMats Wichmann <mats@linux.com>2019-09-25 18:55:31 (GMT)
commit8fb4989b55af2afe3d3de328b59a90eebcef4e49 (patch)
treebddbb148b4098859187c1745340a22b5fa29f03f /src/engine
parentd212e9bfcd1b5f3f540b0b861eb0e0414ad27b8f (diff)
downloadSCons-8fb4989b55af2afe3d3de328b59a90eebcef4e49.zip
SCons-8fb4989b55af2afe3d3de328b59a90eebcef4e49.tar.gz
SCons-8fb4989b55af2afe3d3de328b59a90eebcef4e49.tar.bz2
Docs for InstallVersionedLib and --install-sandbox [ci skip]
Adds --install-sandbox to manpage options and to section on Install builder. Adds mention of InstallVersionedLib to user guide. Fixes #3007 Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'src/engine')
-rw-r--r--src/engine/SCons/Tool/install.xml16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/install.xml b/src/engine/SCons/Tool/install.xml
index 6ae3e30..74169b3 100644
--- a/src/engine/SCons/Tool/install.xml
+++ b/src/engine/SCons/Tool/install.xml
@@ -52,6 +52,22 @@ a builder.
<example_commands>
env.Install('/usr/local/bin', source = ['foo', 'bar'])
</example_commands>
+
+<para>
+If the <option>--install-sandbox</option> command line
+option is given, the target directory will be prefixed
+by the directory path specified.
+This is useful to test installs without installing to
+a "live" location in the system.
+</para>
+
+<para>
+See also &FindInstalledFiles;.
+For more thoughts on installation, see the User Guide
+(particularly the section on Command-Line Targets
+and the chapters on Installing Files and on Alias Targets).
+</para>
+
</summary>
</builder>