summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2003-01-09 06:34:55 (GMT)
committerSteven Knight <knight@baldmt.com>2003-01-09 06:34:55 (GMT)
commit70cbd50755323e60514c354bd0b8166990a6dae7 (patch)
tree4fdcabd7ddee3da00585102b42f3bd823de9ee6d /doc
parent270b93aea9b0543094f95bdb22c914e1189c31d1 (diff)
downloadSCons-70cbd50755323e60514c354bd0b8166990a6dae7.zip
SCons-70cbd50755323e60514c354bd0b8166990a6dae7.tar.gz
SCons-70cbd50755323e60514c354bd0b8166990a6dae7.tar.bz2
Better initial explanation of SConscript files; fix a misformatted table in the StaticObject explanation.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.122
1 files changed, 19 insertions, 3 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index a2f265f..3d5691e 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -71,10 +71,25 @@ in the local directory,
will internally change its working
directory (chdir) to the directory containing the file.
+The
+.I SConstruct
+file can specify subsidiary
+configuration files using the
+.B SConscript()
+function.
+By convention,
+these subsidiary files are named
+.IR SConscript ,
+although any name may be used.
+(Because of this naming convention,
+the term "SConscript files"
+is sometimes used to refer
+generically to all
+.B scons
+configuration files,
+regardless of actual file name.)
+
The configuration files
-(generically referred to as
-.I SConscript
-files)
specify the target files to be built, and
(optionally) the rules to build those targets. Reasonable default
rules exist for building common software components (executable
@@ -913,6 +928,7 @@ function:
.ES
bar_obj = env.StaticObject('bar.c', CCFLAGS='-DBAR')
print "The path to bar_obj is:", str(bar_obj)
+.EE
.B scons
provides the following builders: