[PATCH] rev-parse doc: clarify use of optional / required arguments
From: Nicolas Vigier <hidden>
Date: 2016-06-15 22:59:00
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
"the option is optional" was confusing as it is not the option but its argument which is optional. Signed-off-by: Nicolas Vigier <redacted> --- Documentation/git-rev-parse.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 2b126c0..7ec9221 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt@@ -259,9 +259,10 @@ Each line of options has this format: `<flags>`:: `<flags>` are of `*`, `=`, `?` or `!`. - * Use `=` if the option takes an argument. + * Use `=` if the option requires an argument. - * Use `?` to mean that the option is optional (though its use is discouraged). + * Use `?` if the option takes an optional argument (though its use is + discouraged). * Use `*` to mean that this option should not be listed in the usage generated for the `-h` argument. It's shown for `--help-all` as
--
1.8.4