Subject: Re: Unbalanced closing paren in help of git commit

From: Junio C Hamano <[email-masked]>
Date: Mon, 22 Jul 2024 11:58:54 -0700

Tomas Nordin <[email-masked]> writes:

> So then I make an attempt to provide a patch to remove that closing
> parenthesis. Please tell if it should be done differently somehow. The
> patch was done on top of maint.
>
> From 5da052f43b119949c0ac0c7c3047542bc7474c17 Mon Sep 17 00:00:00 2001
> From: Tomas Nordin <[email-masked]>
> Date: Sun, 21 Jul 2024 13:16:50 +0200
> Subject: [PATCH] doc: remove dangling closing parenthesis

We do not "attach" patches to an e-mail, like this.  Please visit 
https://lore.kernel.org/git/ and check patch messages from others.

An example:
  https://lore.kernel.org/git/[email-masked]/

Your Subject: looks good.  It shows that the author read (at least
some parts of) Documentation/SubmittingPatches.

> * Documentation/git-commit.txt:
>   The second line of the synopsis, starting with [--dry-run] has a
>   dangling closing paren in the second optional group. Probably added by
>   misstake, so remove it.

We do not work file-by-file.  If any reader wants to know which
paths were affected, they can see the diffstat before the patch.

I think what you wrote is just fine otherwise; just drop the "*
Documentation/git-commit" line, dedent the body of the paragraph,
and typofix the "misstake".

Thanks.

> Signed-off-by: Tomas Nordin <[email-masked]>
> ---
>  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]