[PATCH 3/3] Documentation: make explicit that optional arguments must be stuck
- From
Matthieu Moy <matthieu.moy@imag.fr>
- Date
- Sep 18, 2015, 15:01 UTC
- Message-ID
- <1442588510-7379-4-git-send-email-Matthieu.Moy@imag.fr>
- In-Reply-To
- <1442588510-7379-1-git-send-email-Matthieu.Moy@imag.fr>
The behavior of command-line options with optional arguments is documented in gitcli(7), but it is easy for users to miss, and hard for the same user to understand why e.g. "git status -u no" does not work.
Document this explicitly in the documentation of each short option having an optional argument: they are the most error prone since there is no '=' sign between the option and its argument.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> --- Documentation/git-am.txt | 3 ++- Documentation/git-cherry-pick.txt | 3 ++- Documentation/git-commit-tree.txt | 3 ++- Documentation/git-commit.txt | 3 ++- Documentation/git-grep.txt | 4 +++- Documentation/git-merge.txt | 4 +++- Documentation/git-rebase.txt | 3 ++- Documentation/git-revert.txt | 3 ++- Documentation/git-status.txt | 5 +++-- 9 files changed, 21 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index dbea6e7..5f0082e 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -141,7 +141,8 @@ default. You can use `--no-utf8` to override this. -S[<keyid>]:: --gpg-sign[=<keyid>]:: - GPG-sign commits. + GPG-sign commits. The `keyid` argument is optional; if + specified, it must be stuck to the option without a space. --continue:: -r:: diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 83b3cc2..383f57d 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -103,7 +103,8 @@ effect to your index in a row. -S[<keyid>]:: --gpg-sign[=<keyid>]:: - GPG-sign commits. + GPG-sign commits. The `keyid` argument is optional; if + specified, it must be stuck to the option without a space. --ff:: If the current HEAD is the same as the parent of the diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index f5f2a8d..da2f359 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -56,7 +56,8 @@ OPTIONS -S[<keyid>]:: --gpg-sign[=<keyid>]:: - GPG-sign commit. + GPG-sign commits. The `keyid` argument is optional; if + specified, it must be stuck to the option without a space. --no-gpg-sign:: Countermand `commit.gpgSign` configuration variable that is diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 904dafa..99fab5f 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -314,7 +314,8 @@ changes to tracked files. -S[<keyid>]:: --gpg-sign[=<keyid>]:: - GPG-sign commit. + GPG-sign commits. The `keyid` argument is optional; if + specified, it must be stuck to the option without a space. --no-gpg-sign:: Countermand `commit.gpgSign` configuration variable that is diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 1c07c7f..563d011 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -165,7 +165,9 @@ OPTIONS Open the matching files in the pager (not the output of 'grep'). If the pager happens to be "less" or "vi", and the user specified only one pattern, the first file is positioned at - the first match automatically. + the first match automatically. The `pager` argument is + optional; if specified, it must be stuck to the option + without a space. -z:: --null:: diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index a62d672..8543d88 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -67,7 +67,9 @@ include::merge-options.txt[] -S[<keyid>]:: --gpg-sign[=<keyid>]:: - GPG-sign the resulting merge commit. + GPG-sign the resulting merge commit. The `keyid` argument is + optional; if specified, it must be stuck to the option + without a space. -m <msg>:: Set the commit message to be used for the merge commit (in diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index ca03954..1894431 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -294,7 +294,8 @@ which makes little sense. -S[<keyid>]:: --gpg-sign[=<keyid>]:: - GPG-sign commits. + GPG-sign commits. The `keyid` argument is optional; if + specified, it must be stuck to the option without a space. -q:: --quiet:: diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 6388089..cdc3588 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -82,7 +82,8 @@ effect to your index in a row. -S[<keyid>]:: --gpg-sign[=<keyid>]:: - GPG-sign commits. + GPG-sign commits. The `keyid` argument is optional; if + specified, it must be stuck to the option without a space. -s:: --signoff:: diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 335f312..e1e8f57 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -53,8 +53,9 @@ OPTIONS --untracked-files[=<mode>]:: Show untracked files. + -The mode parameter is optional (defaults to 'all'), and is used to -specify the handling of untracked files. +The mode parameter is used to specify the handling of untracked files. +It is optional: it defaults to 'all', and if specified, it must be +stuck to the option (e.g. `-uno`, but not `-u no`). + The possible options are: +
-- 2.5.0.402.g8854c44