diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.asciidoc | 37 |
1 files changed, 30 insertions, 7 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc index 6b2296f..bacb5f6 100644 --- a/doc/manual.asciidoc +++ b/doc/manual.asciidoc @@ -1,7 +1,7 @@ Ninja ===== Evan Martin <martine@danga.com> -v1.4.0, September 2013 +v1.5.0, June 2014 Introduction @@ -581,9 +581,13 @@ Ninja supports this processing in two forms. http://msdn.microsoft.com/en-us/library/hdkef6tk(v=vs.90).aspx[`/showIncludes` flag]. Briefly, this means the tool outputs specially-formatted lines to its stdout. Ninja then filters these lines from the displayed - output. No `depfile` attribute is necessary. + output. No `depfile` attribute is necessary, but the localized string + in front of the the header file path. For instance + `msvc_deps_prefix = Note: including file: ` + for a English Visual Studio (the default). Should be globally defined. + ---- +msvc_deps_prefix = Note: including file: rule cc deps = msvc command = cl /showIncludes -c $in /Fo$out @@ -645,6 +649,21 @@ build heavy_object2.obj: cc heavy_obj2.cc ---------------- +The `console` pool +^^^^^^^^^^^^^^^^^^ + +_Available since Ninja 1.5._ + +There exists a pre-defined pool named `console` with a depth of 1. It has +the special property that any task in the pool has direct access to the +standard input, output and error streams provided to Ninja, which are +normally connected to the user's console (hence the name) but could be +redirected. This can be useful for interactive tasks or long-running tasks +which produce status updates on the console (such as test suites). + +While a task in the `console` pool is running, Ninja's regular output (such +as progress status and output from concurrent tasks) is buffered until +it completes. Ninja file reference -------------------- @@ -773,6 +792,10 @@ keys. stored as `.ninja_deps` in the `builddir`, see <<ref_toplevel,the discussion of `builddir`>>. +`msvc_deps_prefix`:: _(Available since Ninja 1.5.)_ defines the string + which should be stripped from msvc's /showIncludes output. Only + needed when `deps = msvc` and no English Visual Studio version is used. + `description`:: a short description of the command, used to pretty-print the command as it's running. The `-v` flag controls whether to print the full command or its description; if a command fails, the full command @@ -784,9 +807,9 @@ keys. rebuilt if the command line changes; and secondly, they are not cleaned by default. -`in`:: the shell-quoted space-separated list of files provided as - inputs to the build line referencing this `rule`. (`$in` is provided - solely for convenience; if you need some subset or variant of this +`in`:: the space-separated list of files provided as inputs to the build line + referencing this `rule`, shell-quoted if it appears in commands. (`$in` is + provided solely for convenience; if you need some subset or variant of this list of files, just construct a new variable with that list and use that instead.) @@ -795,8 +818,8 @@ keys. `$rspfile_content`; this works around a bug in the MSVC linker where it uses a fixed-size buffer for processing input.) -`out`:: the shell-quoted space-separated list of files provided as - outputs to the build line referencing this `rule`. +`out`:: the space-separated list of files provided as outputs to the build line + referencing this `rule`, shell-quoted if it appears in commands. `restat`:: if present, causes Ninja to re-stat the command's outputs after execution of the command. Each output whose modification time |