summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2003-02-05 22:06:52 (GMT)
committerSteven Knight <knight@baldmt.com>2003-02-05 22:06:52 (GMT)
commit1321ef0af677827deb274d698d06ffa8b73010b0 (patch)
tree12db09379f94382c56b55b9050e5e59950344867 /doc
parent15e31b8bda9f093971af3c3b0136b043ebb02746 (diff)
downloadSCons-1321ef0af677827deb274d698d06ffa8b73010b0.zip
SCons-1321ef0af677827deb274d698d06ffa8b73010b0.tar.gz
SCons-1321ef0af677827deb274d698d06ffa8b73010b0.tar.bz2
Change the default behavior when no arguments are specified to building everything in (or below) the current directory.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.169
1 files changed, 53 insertions, 16 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 7eac0e8..1e9086f 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -135,37 +135,62 @@ ability to define new scanners for unknown input file types.
.B scons
is normally executed in a top-level directory containing a
.I SConstruct
-file, specifying the target or targets to be built as
-command-line arguments. The command
+file, optionally specifying
+as command-line arguments
+the target file or files to be built.
+
+By default, the command
+
+.ES
+scons
+.EE
+
+will build all target files in or below the current directory.
+Explicit default targets
+(to be built when no targets are specified on the command line)
+may be defined the SConscript file(s)
+using the
+.B Default()
+function, described below.
+
+Even when
+.B Default()
+targets are specified in the SConscript file(s),
+all target files in or below the current directory
+may be built by explicitly specifying
+the current directory (.)
+as a command-line target:
.ES
scons .
.EE
-will build all target files in or below the current directory
-.RI ( . ")."
+Building all target files,
+including any files outside of the current directory,
+may be specified by supplying a command-line target
+of the root directory (on POSIX systems):
.ES
scons /
.EE
-will build all target files in or below the root directory (i.e.,
-all files). Specific targets may be supplied:
+or the path name(s) of the volume(s) in which all the targets
+should be built (on Windows systems):
.ES
-scons foo bar
+scons C:\ D:\
.EE
-Targets may be omitted from the command line,
-in which case the targets specified
-in the SConscript file(s) as
-.B Default
-targets will be built:
+To build only specific targets,
+supply them as command-line arguments:
.ES
-scons
+scons foo bar
.EE
+in which case only the specified targets will be built
+(along with any derived files on which they depend).
+
Specifying "cleanup" targets in SConscript files is not
necessary. The
.B -c
@@ -2511,18 +2536,30 @@ and add to the list of default targets.
Multiple targets should be specified as
separate arguments to the
.BR Default ()
-method or as a list.
+method, or as a list.
.BR Default ()
-will also accept the return value of any of the construction environment
+will also accept the Node returned by any
+of a construction environment's
builder methods.
Examples:
.ES
Default('foo', 'bar', 'baz')
Default(['a', 'b', 'c'])
-Default(env.Program('hello', 'hello.c'))
+hello = env.Program('hello', 'hello.c')
+Default(hello)
.EE
+An argument to
+.BR Default ()
+of
+.B None
+will clear all default targets.
+Later calls to
+.BR Default ()
+will add to the (now empty) default-target list
+like normal.
+
.TP
.RI Dir( name ", [" directory ])
This returns an object that represents a given directory