summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2003-03-15 05:30:41 (GMT)
committerSteven Knight <knight@baldmt.com>2003-03-15 05:30:41 (GMT)
commit127d61ac6d0a272bf82cbcaf5923b4ddd302ec7e (patch)
tree518b959654a5e9119b51d229b64a31ca90e4e4f7 /doc
parenta5a29f951bbc993337b8d204d95251cab47c65f6 (diff)
downloadSCons-127d61ac6d0a272bf82cbcaf5923b4ddd302ec7e.zip
SCons-127d61ac6d0a272bf82cbcaf5923b4ddd302ec7e.tar.gz
SCons-127d61ac6d0a272bf82cbcaf5923b4ddd302ec7e.tar.bz2
Change the default SConscriptChdir() behavior to NOT chdir to the SConscript directory.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.132
1 files changed, 21 insertions, 11 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index f0845d6..6d84638 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -3386,24 +3386,34 @@ SConscript('bld/SConscript', src_dir='src', exports='env')
.TP
.RI SConscriptChdir( value )
-When a non-zero
-.I value
-is specified,
-this instructs
+By default,
.B scons
-to change its working directory (chdir)
-to the directory in which each subsidiary
-SConscript file lives.
-Note that you may enable and disable
+changes its working directory
+to the directory in which each
+subsidiary SConscript file lives.
+This behavior may be disabled
+by specifying:
+.ES
+SConscriptChdir(0)
+.EE
+in which case
+.B scons
+will stay in the top-level directory
+while reading all SConscript files.
+(This may be necessary when building from repositories,
+when all the directories in which SConscript files may be found
+don't necessarily exist locally.)
+
+You may enable and disable
this ability by calling
SConscriptChdir()
multiple times:
.ES
-SConscriptChdir(1)
-SConscript('foo/SConscript') # will chdir to foo
SConscriptChdir(0)
-SConscript('bar/SConscript') # will not chdir to bar
+SConscript('foo/SConscript') # will not chdir to foo
+SConscriptChdir(1)
+SConscript('bar/SConscript') # will chdir to bar
.EE
.TP