From: Toon Claes <toon@iotcl.com>
To: Jeff King <peff@peff.net>
Cc: "Junio C Hamano" <gitster@pobox.com>,
"SZEDER Gábor" <szeder.dev@gmail.com>,
git@vger.kernel.org, "Zeger-Jan van de Weg" <git@zjvandeweg.nl>
Subject: Re: [PATCH 1/1] commit: add support to provide --coauthor
Date: Thu, 10 Oct 2019 10:49:23 +0200 [thread overview]
Message-ID: <87sgo1q92k.fsf@iotcl.com> (raw)
In-Reply-To: <20191009203105.GA7007@sigill.intra.peff.net> (Jeff King's message of "Wed, 9 Oct 2019 16:31:06 -0400")
[-- Attachment #1: Type: text/plain, Size: 2402 bytes --]
Jeff King <peff@peff.net> writes:
> Yeah, I'd agree that we should start first with a generic
> trailer line.
IIUC you are suggesting something like this?
git commit --trailer="Co-authored-by: <coauthor>"
I really want to consider this, but I do not understand how that
improves the user experience compared to adding that trailer
manually when typing the commit message in your $EDITOR?
> There might be some advantage to building trailer-specific
> intelligence on top of that (for instance, it would be nice for
> coauthor trailers to expand names the way --author does). But
> that can come after, and might not even be in the form of
> specific command-line options. E.g., if the coauthor trailer
> could be marked in config as "this is an ident", then we we
> would know to expand it. And the same could apply to acked,
> reported, etc.
Wouldn't making it a generic --trailer option make this more
complex? I can image users might even want to use the --trailer
argument to indicate which issue the commit closes:
git commit --trailer="Closes: $BUGNUMBER"
So, how can we make the config understand it has to expand
Co-authored-by and not Closes?
Maybe, because I was looking at
https://git.wiki.kernel.org/index.php/CommitMessageConventions#Trailers,
it will probably be safe to expand a name when a '-by' suffix is
used.
With this pattern in place there is a slight improvement compared
to typing the trailer in your $EDITOR, because the user can pass
--trailer="Anything-by: name" and the trailer is expanded to
`Anything-by: name <name@example.com>".
But I'd like to note another thing, and let me circle back to
SZEDER Gábor's reply:
> I wonder how we are supposed to use this trailer in the Git
> project, in particular in combination with Signed-off-by.
> Should all (co)authors sign off as well? Or will Co-authored-by
> imply Signed-off-by?
For this purpose I think it's useful git understands what
"Co-authored-by" means, so when you run:
git commit -s --coauthor=<coauthor>
The following trailer will be added:
Co-authored-by: <coauthor>
Signed-off-by: <author>
Signed-off-by: <coauthor>
So I'm still pro of adding a --co-author option, but I do
understand the concerns to avoid adding an option for all the
possible trailers found in the link above.
--
Toon
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]
next prev parent reply other threads:[~2019-10-10 8:49 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-08 7:49 [PATCH 1/1] commit: add support to provide --coauthor Toon Claes
2019-10-08 8:35 ` Denton Liu
2019-10-08 10:11 ` Phillip Wood
2019-10-08 12:04 ` Phillip Wood
2019-10-09 1:40 ` SZEDER Gábor
2019-10-09 2:19 ` Junio C Hamano
2019-10-09 11:20 ` brian m. carlson
2019-10-09 11:37 ` Junio C Hamano
2019-10-09 20:31 ` Jeff King
2019-10-10 8:49 ` Toon Claes [this message]
2019-10-10 16:37 ` Jeff King
2019-10-11 4:09 ` Junio C Hamano
2019-10-10 23:07 ` brian m. carlson
2019-10-10 11:49 ` Johannes Schindelin
2019-10-10 17:00 ` Denton Liu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87sgo1q92k.fsf@iotcl.com \
--to=toon@iotcl.com \
--cc=git@vger.kernel.org \
--cc=git@zjvandeweg.nl \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=szeder.dev@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).