summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArthur Milchior <arthur@milchior.fr>2021-11-07 18:00:27 +0100
committerArthur Milchior <arthur@milchior.fr>2021-11-07 18:00:27 +0100
commitc7da3e64f97ef61f9201eff7ad70a8a652f506bb (patch)
tree73dd005beae6be3db383fb14abe662b0ebb8c48f
parent0cd88287a4cd77d11c92c7a9b44bb15fb787a1ee (diff)
downloadninja-c7da3e64f97ef61f9201eff7ad70a8a652f506bb.tar.gz
NF: clarify documentation's part about rules description
The word "eventually" was quite strange here and should probably removed. I suspect "potentially" was meant (which in French is "eventuellement", a standard false friend). In any way, after a quick look at the source/ninja message, I chose to even clarify this part of the doc, indicating that the `-d` option is required here.
-rw-r--r--doc/manual.asciidoc6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc
index 2b948b9..ce36d9b 100644
--- a/doc/manual.asciidoc
+++ b/doc/manual.asciidoc
@@ -304,9 +304,9 @@ _Available since Ninja 1.11._
`restat`:: updates all recorded file modification timestamps in the `.ninja_log`
file. _Available since Ninja 1.10._
-`rules`:: output the list of all rules (eventually with their description
-if they have one). It can be used to know which rule name to pass to
-+ninja -t targets rule _name_+ or +ninja -t compdb+.
+`rules`:: output the list of all rules. It can be used to know which rule name
+to pass to +ninja -t targets rule _name_+ or +ninja -t compdb+. Adding the `-d`
+flag also prints the description of the rules.
`wincodepage`:: Available on Windows hosts (_since Ninja 1.11_).
Prints the Windows code page whose encoding is expected in the build file.