Re: [PATCH] doc: fix typo

From: Patrick Steinhardt <ps@pks.im>
Date: Feb 18, 2025, 06:46 UTC
Message-ID: <Z7QszEnV4EzQMJ9R@pks.im>
In-Reply-To: <20250217130902.2706880-1-mcepl@cepl.eu>

On Mon, Feb 17, 2025 at 02:08:50PM +0100, Matěj Cepl wrote:

> I don’t think there is an option --signed-off-cc (without -by)
> for git send-email.

A couple comments regarding the commit subject and body:

  - The subject should point out _where_ you're fixing a typo.

  - The message should be assertive and use imperative moot, as if
    instructing the documentation to change.

I'd recommend to have a look at commit messages that relate to your file by doing `git log --follow Documentation/git-send-email.adoc` to get a bit of an idea of how this could look like.

> Signed-off-by: Matěj Cepl <mcepl@cepl.eu>
> ---
>  Documentation/git-send-email.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

You should probably rebase your commit on the latest `master` as the file has since been renamed to "git-send-email.adoc".

Show 10 quoted lines

> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
> index bc3ef45acb..d762058907 100644
> --- a/Documentation/git-send-email.txt
> +++ b/Documentation/git-send-email.txt
> @@ -389,7 +389,7 @@ Automating
>  +
>  Default is the value of `sendemail.suppressCc` configuration value; if
>  that is unspecified, default to 'self' if --suppress-from is
> -specified, as well as 'body' if --no-signed-off-cc is specified.
> +specified, as well as 'body' if --no-signed-off-by-cc is specified.

The change itself looks obviously correct to me, thanks!

Patrick