summaryrefslogtreecommitdiff
path: root/doc/man/scons.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/scons.1')
-rw-r--r--doc/man/scons.127
1 files changed, 17 insertions, 10 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index f57169b..5d0f15d 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation
+.\" Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The SCons Foundation
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
@@ -19,9 +19,9 @@
.\" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
.\" WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.\"
-.\" doc/man/scons.1 4577 2009/12/27 19:44:43 scons
+.\" doc/man/scons.1 4629 2010/01/17 22:23:21 scons
.\"
-.TH SCONS 1 "December 2009"
+.TH SCONS 1 "January 2010"
.\" ES - Example Start - indents and turns off line fill
.rm ES
.de ES
@@ -73,7 +73,7 @@ The
.I SConstruct
file can specify subsidiary
configuration files using the
-.B SConscript()
+.BR SConscript ()
function.
By convention,
these subsidiary files are named
@@ -5321,17 +5321,24 @@ The
'\" .I src_dir
'\" arguments are interpreted relative to the directory of the calling
argument is interpreted relative to the directory of the calling
-.BR SConscript file.
+.B SConscript
+file.
See the description of the
.BR VariantDir ()
function below for additional details and restrictions.
If
-'\" .IR variant_dir " is present, but"
+.I variant_dir
+is present,
+'\" but
'\" .IR src_dir " is not,"
-.IR variant_dir " is present,"
-the source directory is relative to the called
-.BR SConscript " file."
+the source directory is the directory in which the
+.B SConscript
+file resides and the
+.B SConscript
+file is evaluated as if it were in the
+.I variant_dir
+directory:
.ES
SConscript('src/SConscript', variant_dir = 'build')
.EE
@@ -5342,7 +5349,7 @@ SConscript('build/SConscript')
.EE
This later paradigm is often used when the sources are
in the same directory as the
-.BR SConstruct file:
+.BR SConstruct:
.ES
SConscript('SConscript', variant_dir = 'build')
.EE