Skip to contentSkip to conversation

git commit synopsis typo?

PATCH In review Joey Hess 4 participants 5 messages Jun 15, 2016 Documentation

lore
Share & tools
lore

Joey Hess

author
#0 lore raw

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>...]
Signature · 1 line
see shy jo
#1 lore raw
Quoted 7 lines · Joey Hess

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.

#2 lore raw

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

From: Jari Aalto <[email protected]>

---
 Documentation/git-commit.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
Documentation/git-commit.txt +2 -2
index 42fb1f5..46ddc80 100644
@@ -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
 -----------
Signature · 1 line
1.7.2.3
#3 lore raw

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

Quoted 1 line · [email protected] wrote:

From: Jari Aalto <[email protected]>

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

Quoted 1 line

Thanks.

[...]

Documentation/git-commit.txt SYNOPSIS · line 15

Quoted 10 lines
Documentation/git-commit.txt +2 -2
@@ -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"?

#4 lore raw

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

Quoted 10 lines · Jonathan Nieder
Quoted 1 line · [email protected] wrote:

From: Jari Aalto <[email protected]>

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

...
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.