threads / patch / 62964

patchdoc: fix typo

Subject: [PATCH] doc: fix typo

## tl;dr

4 messages between Feb 17, 2025 and Feb 19, 2025. Diffs are folded; open one to read it.

replies: 3people: 3as markdown or json

Matěj Cepl· Feb 17, 2025, 13:08 UTC · lore

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

Signed-off-by: Matěj Cepl <mcepl@cepl.eu>
---
 Documentation/git-send-email.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-send-email.txt +1 −1
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.
 
 --[no-]suppress-from::
 	If this is set, do not add the From: address to the cc: list.

-- 
2.48.1
Patrick Steinhardt· Feb 18, 2025, 06:46 UTC · re: Matěj Cepl · lore

Re: [PATCH] doc: fix typo

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
Junio C Hamano· Feb 18, 2025, 18:51 UTC · re: Patrick Steinhardt · lore

Re: [PATCH] doc: fix typo

Patrick Steinhardt <ps@pks.im> writes:
> You should probably rebase your commit on the latest `master` as the
> file has since been renamed to "git-send-email.adoc".
This looks like a 'maint' worthy material, though.

Downporting with cherry-pick should be able to deal with the rename, but queuing with the old name on an older maintenance track and upmerging should be cleaner, so .txt is fine in this case.

Not that I plan to do Git 2.48.2 anytime soon, so either way it does not really matter, though ;-)

Thanks for a review.
Show 14 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

← back to recent threads