summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Niklas Hasse <jhasse@bixense.com>2023-04-21 19:42:18 +0200
committerGitHub <noreply@github.com>2023-04-21 19:42:18 +0200
commitdec50c774ef53815cb6b1166d6adea76119478d2 (patch)
tree2a5e88ee16c78d51a28422b857d5f575688ce93e
parenta660b3e67f32e1d1bdf612a11f3fb77a57a60928 (diff)
parent96d408186bed962f6636eac216510ec2bd706eff (diff)
downloadninja-dec50c774ef53815cb6b1166d6adea76119478d2.tar.gz
Merge pull request #2282 from arxanas/patch-4
Fix formatting for `msvc` tool documentation
-rw-r--r--doc/manual.asciidoc11
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc
index 2479aac..22601e1 100644
--- a/doc/manual.asciidoc
+++ b/doc/manual.asciidoc
@@ -324,20 +324,19 @@ Where `ENVFILE` is a binary file that contains an environment block suitable
for CreateProcessA() on Windows (i.e. a series of zero-terminated strings that
look like NAME=VALUE, followed by an extra zero terminator). Note that this uses
the local codepage encoding.
-
++
This tool also supports a deprecated way of parsing the compiler's output when
-the `/showIncludes` flag is used, and generating a GCC-compatible depfile from it.
+the `/showIncludes` flag is used, and generating a GCC-compatible depfile from it:
+
----
+----
ninja -t msvc -o DEPFILE [-p STRING] -- cl.exe /showIncludes <arguments>
----
+----
+
-
When using this option, `-p STRING` can be used to pass the localized line prefix
that `cl.exe` uses to output dependency information. For English-speaking regions
this is `"Note: including file: "` without the double quotes, but will be different
for other regions.
-
++
Note that Ninja supports this natively now, with the use of `deps = msvc` and
`msvc_deps_prefix` in Ninja files. Native support also avoids launching an extra
tool process each time the compiler must be called, which can speed up builds