From: Nicolas Vigier <boklm@mars-attacks.org>
To: git@vger.kernel.org
Cc: Nicolas Vigier <boklm@mars-attacks.org>
Subject: [PATCH] rev-parse doc: clarify use of optional / required arguments
Date: Mon, 14 Oct 2013 16:23:31 +0200 [thread overview]
Message-ID: <1381760611-9573-1-git-send-email-boklm@mars-attacks.org> (raw)
"the option is optional" was confusing as it is not the option but its
argument which is optional.
Signed-off-by: Nicolas Vigier <boklm@mars-attacks.org>
---
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
next reply other threads:[~2013-10-14 14:23 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-14 14:23 Nicolas Vigier [this message]
2013-10-14 14:36 ` [PATCH] rev-parse doc: clarify use of optional / required arguments Jonathan Nieder
2013-10-14 15:25 ` Nicolas Vigier
2013-10-14 23:57 ` brian m. carlson
2013-10-15 10:49 ` Nicolas Vigier
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1381760611-9573-1-git-send-email-boklm@mars-attacks.org \
--to=boklm@mars-attacks.org \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).