Skip to contentSkip to conversation

doc: remove dangling closing parenthesis

PATCH In review Tomas Nordin 3 participants 6 messages Jul 22, 2024 – Jul 23, 2024 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: remove dangling closing parenthesis

The second line of the synopsis, starting with [--dry-run] has a dangling closing paren in the second optional group. Probably added by mistake, so remove it.

---
 Documentation/git-commit.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-commit.txt +1 -1
index 89ecfc63a8..c822113c11 100644
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
-	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
+	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]
 	   [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
 	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
 	   [--date=<date>] [--cleanup=<mode>] [--[no-]status]
Signature · 1 line
2.39.2
#1 lore raw
Quoted 14 lines · Tomas Nordin

The second line of the synopsis, starting with [--dry-run] has a dangling closing paren in the second optional group. Probably added by mistake, so remove it.

---
 Documentation/git-commit.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-commit.txt +0 -0
index 89ecfc63a8..c822113c11 100644

Documentation/git-commit.txt SYNOPSIS · line 15

Quoted 8 lines
Documentation/git-commit.txt +1 -1
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
-	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
+	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]
 	   [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
 	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
 	   [--date=<date>] [--cleanup=<mode>] [--[no-]status]

Wonderful. Thanks.

Will queue.

#2 lore raw
Quoted 3 lines · Junio C Hamano

Wonderful. Thanks.

Will queue.

Spoke too early. We need a matching change to in-code help, otherwise t0450 would break.

Here is what I have, which hopefully needs no more fix-ups.

Thanks.

----- >8 --------- >8 -----
Subject: [PATCH] doc: remove dangling closing parenthesis

The second line of the synopsis, starting with [--dry-run] has a dangling closing paren in the second optional group. Probably added by mistake, so remove it.

---
 Documentation/git-commit.txt | 2 +-
 builtin/commit.c             | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/git-commit.txt +1 -1
index 89ecfc63a8..c822113c11 100644
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
-	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
+	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]
 	   [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
 	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
 	   [--date=<date>] [--cleanup=<mode>] [--[no-]status]
builtin/commit.c +1 -1
index 6e1484446b..7f9dd45d05 100644
@@ -41,7 +41,7 @@
 
 static const char * const builtin_commit_usage[] = {
 	N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n"
-	   "           [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]\n"
+	   "           [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n"
 	   "           [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n"
 	   "           [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n"
 	   "           [--date=<date>] [--cleanup=<mode>] [--[no-]status]\n"
Signature · 1 line
2.46.0-rc1-52-gda884b23f2
#3 lore raw
Quoted 4 lines · Junio C Hamano
Quoted 2 lines · Junio C Hamano

Wonderful. Thanks.

Quoted 9 lines
Quoted 1 line

Will queue.

Spoke too early. We need a matching change to in-code help, otherwise t0450 would break.

Here is what I have, which hopefully needs no more fix-ups.

Thanks.

Can confirm that your patch below fixes t0450.

Quoted 41 lines

----- >8 --------- >8 -----
Subject: [PATCH] doc: remove dangling closing parenthesis

The second line of the synopsis, starting with [--dry-run] has a dangling closing paren in the second optional group. Probably added by mistake, so remove it.

---
 Documentation/git-commit.txt | 2 +-
 builtin/commit.c             | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/git-commit.txt +1 -1
index 89ecfc63a8..c822113c11 100644
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
-	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
+	   [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]
 	   [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
 	   [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
 	   [--date=<date>] [--cleanup=<mode>] [--[no-]status]
builtin/commit.c +1 -2
index 6e1484446b..7f9dd45d05 100644
@@ -41,7 +41,7 @@
 
 static const char * const builtin_commit_usage[] = {
 	N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n"
-	   "           [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]\n"
+	   "           [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n"
 	   "           [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n"
 	   "           [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n"
 	   "           [--date=<date>] [--cleanup=<mode>] [--[no-]status]\n"
--
Quoted 1 line

2.46.0-rc1-52-gda884b23f2

Looks good! Thanks.

#4 lore raw
In reply to Junio C Hamano
Quoted 8 lines · Junio C Hamano
Quoted 3 lines · Junio C Hamano

Wonderful. Thanks.

Will queue.

Spoke too early. We need a matching change to in-code help, otherwise t0450 would break.

Good test suit (which I didn't run)...

#5 lore raw
Quoted 4 lines · Tomas Nordin
Quoted 2 lines · Junio C Hamano

Junio C Hamano <[email protected]> writes:

Quoted 8 lines
Quoted 6 lines
Quoted 3 lines

Wonderful. Thanks.

Will queue.

Spoke too early. We need a matching change to in-code help, otherwise t0450 would break.

Good test suit (which I didn't run)...

It skips a large number of commands that have mismatch in "git cmd -h" output and "git cmd --help | head" output. I am not sure what our longer term plans are. Perhaps make it a #leftoverbit item to shrink the t/t0450/txt-help-mismatches file? I dunno.

Thanks.