diff options
| author | Nicolas Despres <nicolas.despres@gmail.com> | 2012-04-19 12:26:33 (GMT) |
|---|---|---|
| committer | Nicolas Despres <nicolas.despres@gmail.com> | 2012-04-24 09:14:28 (GMT) |
| commit | 34ad4de66455d06b5586579f9f304b4c904ac7cc (patch) | |
| tree | 71a3ea5b3e4a6d2f13c965d3acf585fb3a9e05f1 /doc | |
| parent | 34ff2d9cf25cd6a2a9adb63918c3383ad4047db8 (diff) | |
| download | Ninja-34ad4de66455d06b5586579f9f304b4c904ac7cc.zip Ninja-34ad4de66455d06b5586579f9f304b4c904ac7cc.tar.gz Ninja-34ad4de66455d06b5586579f9f304b4c904ac7cc.tar.bz2 | |
Introduce NINJA_STATUS env var for customization.
Some people may want to display different relevant information about
the progress of the build. Also it can be usefull to debug jobs
allocation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.asciidoc | 17 |
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 -------------------- |