diff mbox series

[1/1] doc: remove dangling closing parenthesis

Message ID 20240722225302.124356-1-tomasn@posteo.net (mailing list archive)
State New
Headers show
Series [1/1] doc: remove dangling closing parenthesis | expand

Commit Message

Tomas Nordin July 22, 2024, 10:53 p.m. UTC
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.

Signed-off-by: Tomas Nordin <tomasn@posteo.net>
---
 Documentation/git-commit.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Junio C Hamano July 22, 2024, 10:59 p.m. UTC | #1
Tomas Nordin <tomasn@posteo.net> writes:

> 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.
>
> Signed-off-by: Tomas Nordin <tomasn@posteo.net>
> ---
>  Documentation/git-commit.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
> index 89ecfc63a8..c822113c11 100644
> --- a/Documentation/git-commit.txt
> +++ b/Documentation/git-commit.txt
> @@ -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.
Junio C Hamano July 23, 2024, 12:35 a.m. UTC | #2
Junio C Hamano <gitster@pobox.com> writes:

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

Signed-off-by: Tomas Nordin <tomasn@posteo.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-commit.txt | 2 +-
 builtin/commit.c             | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 89ecfc63a8..c822113c11 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -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]
diff --git a/builtin/commit.c b/builtin/commit.c
index 6e1484446b..7f9dd45d05 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -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"
karthik nayak July 23, 2024, 8:50 a.m. UTC | #3
Junio C Hamano <gitster@pobox.com> writes:

> Junio C Hamano <gitster@pobox.com> writes:
>
>> 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.
>

Can confirm that your patch below fixes t0450.

> ----- >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.
>
> Signed-off-by: Tomas Nordin <tomasn@posteo.net>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/git-commit.txt | 2 +-
>  builtin/commit.c             | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
> index 89ecfc63a8..c822113c11 100644
> --- a/Documentation/git-commit.txt
> +++ b/Documentation/git-commit.txt
> @@ -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]
> diff --git a/builtin/commit.c b/builtin/commit.c
> index 6e1484446b..7f9dd45d05 100644
> --- a/builtin/commit.c
> +++ b/builtin/commit.c
> @@ -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"
> --
> 2.46.0-rc1-52-gda884b23f2

Looks good! Thanks.
Tomas Nordin July 23, 2024, 11:44 a.m. UTC | #4
Junio C Hamano <gitster@pobox.com> writes:

> Junio C Hamano <gitster@pobox.com> writes:
>
>> 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)...
Junio C Hamano July 23, 2024, 4:48 p.m. UTC | #5
Tomas Nordin <tomasn@posteo.net> writes:

> Junio C Hamano <gitster@pobox.com> writes:
>
>> Junio C Hamano <gitster@pobox.com> writes:
>>
>>> 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.
diff mbox series

Patch

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 89ecfc63a8..c822113c11 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -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]