diff mbox series

[v2] doc(send-email): use correct name of the --signed-off-by-cc in git send-email doc

Message ID 20250218085913.1381537-1-mcepl@cepl.eu (mailing list archive)
State New
Headers show
Series [v2] doc(send-email): use correct name of the --signed-off-by-cc in git send-email doc | expand

Commit Message

Matěj Cepl Feb. 18, 2025, 8:58 a.m. UTC
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>
---
Rebase on the top of the current master (Whoops!) and improve the commit message.

 Documentation/git-send-email.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Patrick Steinhardt Feb. 18, 2025, 11:22 a.m. UTC | #1
On Tue, Feb 18, 2025 at 09:58:38AM +0100, Matěj Cepl wrote:
> 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>
> ---
> Rebase on the top of the current master (Whoops!) and improve the commit message.

It's better, but still not quite there:

  - The subject now uses `doc(send-email)`, which is an idiom we don't
    use over here.

  - The commit message still doesn't use imperative mood.

I know, we're quite pedantic about commit messages over here, but please
bear with us :) How about this instead:

    docs: fix misspelled `--no-signed-off-by-cc` in git-send-email(1)

    In git-send-email(1) we reference the `--no-signed-off-cc` command
    line argument. This argument does not exist and never has existed,
    but it is an obvious misspelling of `--no-signed-off-by-cc`.

    Fix the misspelled argument.

    Signed-off-by: ...

It would also be great if you send future revisions of a patch series in
the same thread. You can do so via `--in-reply-to`, where the parameter
is the message ID of the first message of the first version of your
patch series.

Thanks!

Patrick
Matěj Cepl Feb. 18, 2025, 3:21 p.m. UTC | #2
On Tue Feb 18, 2025 at 12:25 PM CET, Patrick Steinhardt wrote:
> I know, we're quite pedantic about commit messages over here, but please
> bear with us :) How about this instead:

No, I don’t think you are and I don’t think I will. There are no
rules, there are people who are in and can do whatever they want
to do and anybody who dares to contribute for the first time is
needlessly harrassed. See this:

mitmanek:git (git-send-email-manpage-fix) $ git log --oneline --follow Documentation/git-send-email.adoc |head
f18690968f doc(send-email): use correct name of the --signed-off-by-cc in git send-email doc
1f010d6bdf doc: use .adoc extension for AsciiDoc files
7ffcbafbf3 send-email: document --mailmap and associated configuration
c038a6f1d7 send-email: teach git send-email option to translate aliases
0620ae0f5b doc: format alternatives in synopsis
82d75402d5 documentation: send-email: use camel case consistently
2162f9f6f8 doc: enforce dashes in placeholders
d05b08cd52 doc: switch links to https
3ec6167567 send-email: handle to/cc/bcc from --compose message
e0c7e2c326 doc/send-email: mention handling of "reply-to" with --compose
cf6cac2005 documentation: wording improvements
ba92106e93 send-email: add --header-cmd, --no-header-cmd options
839ebad442 send-email docs: Remove mention of discontinued gmail feature
ba4324c4e1 e-mail workflow: Message-ID is spelled with ID in both capital letters
a2634646eb docs: git-send-email: difference between ssl and tls smtp-encryption
bac1d52cfe send-email docs: de-duplicate configuration sections
a2ce608244 send-email docs: add format-patch options
cd5b33fbdc git-send-email: add option to specify sendmail command
155067ab4f git-send-email.txt: mention less secure app access with Gmail
3abd4a67d9 Documentation: stylistically normalize references to Signed-off-by:
mitmanek:git (git-send-email-manpage-fix) $ 

This is not being pedantic about anything. And all that in the
email-driven project, where changing the patch before applying
is absolutely no problem whatsoever. And all that harassment for
three character change.

This harassment and complete NIH-syndrom ruling everything (git
is the only project I have met so far, which didn’t settle on
the vaguely K&R style for shell scripting, but why not to pester
newbies with need to have specific settings in everything just
for this one project, right?) leads me to abandoning this and
couple of other attempts to contribute. Of course, accepting
conventional commits (the only real standard in commit messages I
know about) is beneath your station in life.

Have a nice day,

Matěj
diff mbox series

Patch

diff --git a/Documentation/git-send-email.adoc b/Documentation/git-send-email.adoc
index 7f223db42d..5287f1115f 100644
--- a/Documentation/git-send-email.adoc
+++ b/Documentation/git-send-email.adoc
@@ -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.