summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPeter Collingbourne <peter@pcc.me.uk>2011-10-15 18:55:33 (GMT)
committerPeter Collingbourne <peter@pcc.me.uk>2011-10-15 19:37:11 (GMT)
commit5a7151a8a6ab989a4016f03306b020df38f21732 (patch)
tree5d370ccd781409fd459f31adfe9dd9c4989a8562 /doc
parent7cf2bdffe2a95ea5e30e9c3166ef4398add8e6b9 (diff)
downloadNinja-5a7151a8a6ab989a4016f03306b020df38f21732.zip
Ninja-5a7151a8a6ab989a4016f03306b020df38f21732.tar.gz
Ninja-5a7151a8a6ab989a4016f03306b020df38f21732.tar.bz2
Make the command line interface for the clean tool consistent
Since we have started using command line flags for the clean tool, it is inconsistent to keep the "target" and "rule" prefixes. Replace them with a "-r" flag with the same semantics as "rule".
Diffstat (limited to 'doc')
-rw-r--r--doc/manual.asciidoc17
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc
index 7e7063b..ff197b1 100644
--- a/doc/manual.asciidoc
+++ b/doc/manual.asciidoc
@@ -383,15 +383,14 @@ one. It can be used to know which rule name to pass to
+ninja -t targets rule _name_+.
`clean`:: remove built files. If used like this +ninja -t clean+ it removes
-all the built files, except for those created by the generator. If used like
-this +ninja -t clean -g+ it also removes built files created by the generator.
-If used like this +ninja -t clean _targets..._+ or like this +ninja -t clean
-target _targets..._+ it removes the given targets and recursively all files
-built for it. If used like this +ninja -t clean rule _rules_+ it removes
-all files built using the given rules. The depfiles are not removed. Files
-created but not referenced in the graph are not removed. This tool takes
-in account the +-v+ and the +-n+ options (note that +-n+ implies +-v+).
-It returns non-zero if an error occurs.
+all the built files, except for those created by the generator. If used
+like this +ninja -t clean -g+ it also removes built files created by the
+generator. If used like this +ninja -t clean _targets..._+ it removes the
+given targets and recursively all files built for it. If used like this
++ninja -t clean -r _rules_+ it removes all files built using the given
+rules. The depfiles are not removed. Files created but not referenced in
+the graph are not removed. This tool takes in account the +-v+ and the +-n+
+options (note that +-n+ implies +-v+). It returns non-zero if an error occurs.
Ninja file reference
--------------------