summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2002-12-27 04:52:10 (GMT)
committerSteven Knight <knight@baldmt.com>2002-12-27 04:52:10 (GMT)
commit38d41c10db89f34f72a62d6ada1a4122d4a1cc3f (patch)
tree3d694990b638eddffb9ff187c4be58e9a9004ab2 /doc
parented5697feb65d129a082d59408ddfcfac4ee2134b (diff)
downloadSCons-38d41c10db89f34f72a62d6ada1a4122d4a1cc3f.zip
SCons-38d41c10db89f34f72a62d6ada1a4122d4a1cc3f.tar.gz
SCons-38d41c10db89f34f72a62d6ada1a4122d4a1cc3f.tar.bz2
Implement the Clean() function.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.130
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 5ef46a8..26215ad 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -168,6 +168,8 @@ scons -c build export
.EE
to remove target files under build and export.
+Additional files or directories to remove can be specified using the
+Clean() function.
A subset of a hierarchical tree may be built by
remaining at the top-level directory (where the
@@ -277,6 +279,8 @@ Ignored for compatibility with non-GNU versions of
-c, --clean, --remove
Clean up by removing all target files for which a construction
command is specified.
+Also remove any files or directories associated to the construction command
+using the Clean() function.
.\" .TP
.\" --cache-disable, --no-cache
@@ -2287,6 +2291,32 @@ is usually safe, and is always more efficient than
.IR duplicate =1.
.TP
+.RI Clean ( target, files_or_dirs )
+This specifies a list of files or directories which should be removed
+whenever the target is specified with the
+.B -c
+command line option.
+Multiple calls to
+.BR Clean ()
+are legal,
+and create a new target or add files and directories to the
+clean list for the specified target.
+
+Multiple files or directories should be specified
+either as separate arguments to the
+.BR Clean ()
+method, or as a list.
+.BR Clean ()
+will also accept the return value of any of the construction environment
+Builder methods.
+Examples:
+
+.ES
+Clean('foo', ['bar', 'baz'])
+Clean('dist', env.Program('hello', 'hello.c'))
+.EE
+
+.TP
.RI Default( targets )
This specifies a list of default targets,
which will be built by