summaryrefslogtreecommitdiffstats
path: root/doc/manual.asciidoc
diff options
context:
space:
mode:
authorEvan Martin <martine@danga.com>2012-03-06 18:15:19 (GMT)
committerEvan Martin <martine@danga.com>2012-03-06 18:15:19 (GMT)
commit523734f2cfac273df4dfc90972e23bdccb34745a (patch)
tree5ba987783bf2b065e968891c7b4f3df99db8b414 /doc/manual.asciidoc
parent1db65b99ebd3fca77c14907dc3ed934cc4e72326 (diff)
downloadNinja-523734f2cfac273df4dfc90972e23bdccb34745a.zip
Ninja-523734f2cfac273df4dfc90972e23bdccb34745a.tar.gz
Ninja-523734f2cfac273df4dfc90972e23bdccb34745a.tar.bz2
adjust rspfile docs to properly render
Diffstat (limited to 'doc/manual.asciidoc')
-rw-r--r--doc/manual.asciidoc32
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc
index 0387c97..a330095 100644
--- a/doc/manual.asciidoc
+++ b/doc/manual.asciidoc
@@ -492,19 +492,19 @@ aborting due to a missing input.
rebuilt if the command line changes; and secondly, they are not
cleaned by default.
-`restat`:: if present, causes Ninja to re-stat the command's outputs after
- execution of the command. Each output whose modification time the command
- did not change will be treated as though it had never needed to be built.
- This may cause the output's reverse dependencies to be removed from the
- list of pending build actions.
-
-`rspfile`
-`rspfile_content`:: if present (both), Ninja will use a 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.
+`restat`:: if present, causes Ninja to re-stat the command's outputs
+ after execution of the command. Each output whose modification time
+ the command did not change will be treated as though it had never
+ needed to be built. This may cause the output's reverse
+ dependencies to be removed from the list of pending build actions.
+
+`rspfile`, `rspfile_content`:: if present (both), Ninja will use a
+ 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.
+
-This is particularly useful on Windows OS, where the maximal length of
+This is particularly useful on Windows OS, where the maximal length of
a command line is limited and response files must be used instead.
+
Use it like in the following example:
@@ -514,13 +514,13 @@ rule link
command = link.exe /OUT$out [usual link flags here] @$out.rsp
rspfile = $out.rsp
rspfile_content = $in
-
+
build myapp.exe: link a.obj b.obj [possibly many other .obj files]
----
-Additionally, the special `$in` and `$out` variables expand to the
-space-separated list of files provided to the `build` line referencing
-this `rule`.
+Finally, the special `$in` and `$out` variables expand to the
+shell-quoted space-separated list of files provided to the `build`
+line referencing this `rule`.
Build dependencies
~~~~~~~~~~~~~~~~~~