threads / discuss / 25871

git commit synopsis typo?

Subject: git commit synopsis typo?

## tl;dr

5 messages between Nov 29, 2010 and Dec 1, 2010.

replies: 4people: 4as markdown or json

Joey Hess· Nov 29, 2010, 17:37 UTC · lore

Shouldn't the -i and -o options be listed before the -- option?

       git commit [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
                  [(-c | -C) <commit>] [-F <file> | -m <msg>] [--reset-author]
                  [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
                  [--date=<date>] [--cleanup=<mode>] [--status | --no-status] [--]
                  [[-i | -o ]<file>...]

-- 
see shy jo

Junio C Hamano· Nov 29, 2010, 20:24 UTC · re: Joey Hess · lore

Re: git commit synopsis typo?

Joey Hess <joey@kitenet.net> writes:

Show 7 quoted lines

> Shouldn't the -i and -o options be listed before the -- option?
>
>        git commit [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
>                   [(-c | -C) <commit>] [-F <file> | -m <msg>] [--reset-author]
>                   [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
>                   [--date=<date>] [--cleanup=<mode>] [--status | --no-status] [--]
>                   [[-i | -o ]<file>...]

Yes, please make it so ;-)

Thanks.

jari.aalto@cante.net· Dec 1, 2010, 14:51 UTC · re: Junio C Hamano · lore

[PATCH] git-commit.txt: (synopsis): move -i and -o before "--"

From: Jari Aalto <jari.aalto@cante.net>

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
---
 Documentation/git-commit.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 42fb1f5..46ddc80 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -11,8 +11,8 @@ SYNOPSIS
 'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
 	   [(-c | -C) <commit>] [-F <file> | -m <msg>] [--reset-author]
 	   [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
-	   [--date=<date>] [--cleanup=<mode>] [--status | --no-status] [--]
-	   [[-i | -o ]<file>...]
+	   [--date=<date>] [--cleanup=<mode>] [--status | --no-status]
+	   [-i | -o ] [--] [<file>...]
 
 DESCRIPTION
 -----------

-- 
1.7.2.3

Jonathan Nieder· Dec 1, 2010, 16:39 UTC · re: jari.aalto@cante.net · lore

Re: [PATCH] git-commit.txt: (synopsis): move -i and -o before "--"

jari.aalto@cante.net wrote:

> From: Jari Aalto <jari.aalto@cante.net>

"The -i and -o options cannot be used after --, so do not get the reader's hopes up by suggesting they can.

Reported-by: Joey Hess <joey@kitenet.net>"

> Signed-off-by: Jari Aalto <jari.aalto@cante.net>

Thanks.

[...]

Show 10 quoted lines

> --- a/Documentation/git-commit.txt
> +++ b/Documentation/git-commit.txt
> @@ -11,8 +11,8 @@ SYNOPSIS
>  'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
>  	   [(-c | -C) <commit>] [-F <file> | -m <msg>] [--reset-author]
>  	   [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
> -	   [--date=<date>] [--cleanup=<mode>] [--status | --no-status] [--]
> -	   [[-i | -o ]<file>...]
> +	   [--date=<date>] [--cleanup=<mode>] [--status | --no-status]
> +	   [-i | -o ] [--] [<file>...]

While at it, shouldn't we get rid of the extra space after "-o"?

Junio C Hamano· Dec 1, 2010, 19:01 UTC · re: Jonathan Nieder · lore

Re: [PATCH] git-commit.txt: (synopsis): move -i and -o before "--"

Jonathan Nieder <jrnieder@gmail.com> writes:

Show 10 quoted lines

> jari.aalto@cante.net wrote:
>
>> From: Jari Aalto <jari.aalto@cante.net>
>
> "The -i and -o options cannot be used after --, so do not get the reader's
> hopes up by suggesting they can.
>
> Reported-by: Joey Hess <joey@kitenet.net>"
> ...
> While at it, shouldn't we get rid of the extra space after "-o"?

Will do all of these at my end.

Thanks for an excellent coach to other contributors, as always.