summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEvan Martin <martine@danga.com>2012-04-26 03:23:26 (GMT)
committerEvan Martin <martine@danga.com>2012-04-26 03:23:26 (GMT)
commit496f7729009c46691a3210fcb67c418aa102da96 (patch)
tree7cbbb34ada96929eb2af1af0be266375445a9000 /doc
parent3fda08c34d4c91a4d16855ce40a2d0ab13a4d768 (diff)
parenteeb572aa84564768311b70e14c5b5354a31bfd29 (diff)
downloadNinja-496f7729009c46691a3210fcb67c418aa102da96.zip
Ninja-496f7729009c46691a3210fcb67c418aa102da96.tar.gz
Ninja-496f7729009c46691a3210fcb67c418aa102da96.tar.bz2
Merge branch 'custom_ninja_status' of git://github.com/polrop/ninja
Diffstat (limited to 'doc')
-rw-r--r--doc/manual.asciidoc17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc
index a330095..0201820 100644
--- a/doc/manual.asciidoc
+++ b/doc/manual.asciidoc
@@ -375,6 +375,23 @@ 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+).
+Environment variables
+---------------------
+
+Ninja supports various environment variables to control its behavior.
+
+`NINJA_STATUS`:: The progress status printed before the rule being run.
+Several placeholders are available:
+* `%s`: The number of started edges.
+* `%t`: The total number of edges that must be run to complete the build.
+* `%r`: The number of currently running edges.
+* `%u`: The number of remaining edges to start.
+* `%f`: The number of finished edges.
+* `%%`: A plain `%` character.
+* The default progress status is `"[%s/%t] "` (note the trailing space
+to separate from the build rule). Another example of possible progress status
+could be `"[%u/%r/%f] "`.
+
Ninja file reference
--------------------