summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Niklas Hasse <jhasse@bixense.com>2023-01-31 07:43:16 +0100
committerGitHub <noreply@github.com>2023-01-31 07:43:16 +0100
commit2323fedb36e53817521e7ce40cd0b2d7254254b9 (patch)
treed09be70cccd57c7af928afde9f35ab4fea061e02
parente129ff3e404a1430fe96baa284a7180b9390ac5d (diff)
parent18d692c9636a9dd744a3f8540d6ac35a06481640 (diff)
downloadninja-2323fedb36e53817521e7ce40cd0b2d7254254b9.tar.gz
Merge pull request #2250 from tocic/fix/docs_typos
Fix typos in docs
-rw-r--r--README.md2
-rw-r--r--doc/manual.asciidoc20
2 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index d763766..1ca56c5 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ See [the manual](https://ninja-build.org/manual.html) or
`doc/manual.asciidoc` included in the distribution for background
and more details.
-Binaries for Linux, Mac, and Windows are available at
+Binaries for Linux, Mac and Windows are available on
[GitHub](https://github.com/ninja-build/ninja/releases).
Run `./ninja -h` for Ninja help.
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc
index 214dca4..2479aac 100644
--- a/doc/manual.asciidoc
+++ b/doc/manual.asciidoc
@@ -24,7 +24,7 @@ Where other build systems are high-level languages, Ninja aims to be
an assembler.
Build systems get slow when they need to make decisions. When you are
-in a edit-compile cycle you want it to be as fast as possible -- you
+in an edit-compile cycle you want it to be as fast as possible -- you
want the build system to do the minimum work necessary to figure out
what needs to be built immediately.
@@ -222,14 +222,14 @@ found useful during Ninja's development. The current tools are:
`browse`:: browse the dependency graph in a web browser. Clicking a
file focuses the view on that file, showing inputs and outputs. This
-feature requires a Python installation. By default port 8000 is used
+feature requires a Python installation. By default, port 8000 is used
and a web browser will be opened. This can be changed as follows:
+
----
ninja -t browse --port=8000 --no-browser mytarget
----
+
-`graph`:: output a file in the syntax used by `graphviz`, a automatic
+`graph`:: output a file in the syntax used by `graphviz`, an automatic
graph layout tool. Use it like:
+
----
@@ -261,7 +261,7 @@ output files are out of date.
rebuild those targets.
_Available since Ninja 1.11._
-`clean`:: remove built files. By default it removes all built files
+`clean`:: remove built files. By default, it removes all built files
except for those created by the generator. Adding the `-g` flag also
removes built files created by the generator (see <<ref_rule,the rule
reference for the +generator+ attribute>>). Additional arguments are
@@ -674,14 +674,14 @@ Ninja supports this processing in two forms.
as a temporary).
2. `deps = msvc` specifies that the tool outputs header dependencies
- in the form produced by Visual Studio's compiler's
+ in the form produced by the Visual Studio compiler's
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, but the localized string
- in front of the the header file path. For instance
+ in front of the header file path should be globally defined. For instance,
`msvc_deps_prefix = Note: including file:`
- for a English Visual Studio (the default). Should be globally defined.
+ for an English Visual Studio (the default).
+
----
msvc_deps_prefix = Note: including file:
@@ -964,14 +964,14 @@ Fundamentally, command lines behave differently on Unixes and Windows.
On Unixes, commands are arrays of arguments. The Ninja `command`
variable is passed directly to `sh -c`, which is then responsible for
-interpreting that string into an argv array. Therefore the quoting
+interpreting that string into an argv array. Therefore, the quoting
rules are those of the shell, and you can use all the normal shell
operators, like `&&` to chain multiple commands, or `VAR=value cmd` to
set environment variables.
On Windows, commands are strings, so Ninja passes the `command` string
directly to `CreateProcess`. (In the common case of simply executing
-a compiler this means there is less overhead.) Consequently the
+a compiler this means there is less overhead.) Consequently, the
quoting rules are determined by the called program, which on Windows
are usually provided by the C library. If you need shell
interpretation of the command (such as the use of `&&` to chain
@@ -1064,7 +1064,7 @@ A build edge can list another build edge as a validation even if the second
edge depends on the first.
Validations are designed to handle rules that perform error checking but
-don't produce any artifacts needed by the build, for example static
+don't produce any artifacts needed by the build, for example, static
analysis tools. Marking the static analysis rule as an implicit input
of the main build rule of the source files or of the rules that depend
on the main build rule would slow down the critical path of the build,