diff options
author | Evan Martin <martine@danga.com> | 2013-02-17 01:32:42 (GMT) |
---|---|---|
committer | Evan Martin <martine@danga.com> | 2013-02-17 01:32:42 (GMT) |
commit | e6d618556c1a9042af8cc069911dd248246e9e8e (patch) | |
tree | 497506ab6a45fa0afe879341bf46557b092afbef /doc | |
parent | d3c4cf1b36b132a2fc6f79970b32046ac4eaeef9 (diff) | |
download | Ninja-e6d618556c1a9042af8cc069911dd248246e9e8e.zip Ninja-e6d618556c1a9042af8cc069911dd248246e9e8e.tar.gz Ninja-e6d618556c1a9042af8cc069911dd248246e9e8e.tar.bz2 |
rearrange env variable section layout
Diffstat (limited to 'doc')
-rw-r--r-- | doc/manual.asciidoc | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc index 93e34e2..60439fd 100644 --- a/doc/manual.asciidoc +++ b/doc/manual.asciidoc @@ -209,20 +209,22 @@ you don't need to pass `-j`.) Environment variables ~~~~~~~~~~~~~~~~~~~~~ -Ninja supports one environment variable to control its behavior. +Ninja supports one environment variable to control its behavior: +`NINJA_STATUS`, the progress status printed before the rule being run. -`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. -* `%p`: The percentage of started edges. -* `%r`: The number of currently running edges. -* `%u`: The number of remaining edges to start. -* `%f`: The number of finished edges. -* `%o`: Overall rate of finished edges per second -* `%c`: Current rate of finished edges per second (average over builds specified by -j or its default) -* `%%`: A plain `%` character. -* The default progress status is `"[%s/%t] "` (note the trailing space + +`%s`:: The number of started edges. +`%t`:: The total number of edges that must be run to complete the build. +`%p`:: The percentage of started edges. +`%r`:: The number of currently running edges. +`%u`:: The number of remaining edges to start. +`%f`:: The number of finished edges. +`%o`:: Overall rate of finished edges per second +`%c`:: Current rate of finished edges per second (average over builds specified by -j or its default) +`%%`:: 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] "`. |