summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorNico Weber <thakis@chromium.org>2014-05-24 22:52:52 (GMT)
committerNico Weber <thakis@chromium.org>2014-05-24 22:52:52 (GMT)
commit385b7f39f5eb602dd90d9aedee0f6147b695c762 (patch)
treedaf41af8ae42f22c2316f05632d449124a875152 /doc
parentbc239cca4f3f0757ba34d0306fbc2a2b75d067a2 (diff)
downloadNinja-385b7f39f5eb602dd90d9aedee0f6147b695c762.zip
Ninja-385b7f39f5eb602dd90d9aedee0f6147b695c762.tar.gz
Ninja-385b7f39f5eb602dd90d9aedee0f6147b695c762.tar.bz2
reword manual for depfile/rspfile escaping change
Diffstat (limited to 'doc')
-rw-r--r--doc/manual.asciidoc16
1 files changed, 7 insertions, 9 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc
index aea1784..fcf3db3 100644
--- a/doc/manual.asciidoc
+++ b/doc/manual.asciidoc
@@ -783,8 +783,7 @@ keys.
`depfile`:: path to an optional `Makefile` that contains extra
_implicit dependencies_ (see <<ref_dependencies,the reference on
dependency types>>). This is explicitly to support C/C++ header
- dependencies; see <<ref_headers,the full discussion>>. `out`, `in`, and
- `in_newline` are not shell-quoted when used to set `depfile`.
+ dependencies; see <<ref_headers,the full discussion>>.
`deps`:: _(Available since Ninja 1.3.)_ if present, must be one of
`gcc` or `msvc` to specify special dependency processing. See
@@ -807,9 +806,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.)
@@ -818,8 +817,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
@@ -831,8 +830,7 @@ keys.
response file for the given command, i.e. write the selected string
(`rspfile_content`) to the given file (`rspfile`) before calling the
command and delete the file after successful execution of the
- command. `out`, `in`, and `in_newline` are not shell-quoted when used to set
- `rspfile`.
+ command.
+
This is particularly useful on Windows OS, where the maximal length of
a command line is limited and response files must be used instead.