git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/1] commit: add support to provide --coauthor

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Oct 10, 2019, 11:49 UTC
Message-ID
<nycvar.QRO.7.76.6.1910101345120.46@tvgsbejvaqbjf.bet>
In-Reply-To
<20191009203105.GA7007@sigill.intra.peff.net>
Hi,
On Wed, 9 Oct 2019, Jeff King wrote:
Show 20 quoted lines
> On Wed, Oct 09, 2019 at 11:19:47AM +0900, Junio C Hamano wrote:
>
> > > 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?
> >
> > I think we have been happy with (1) a comment at the end of the log
> > message that says X worked together with Y and Z to produce this
> > patch, and (2) the trailer block that has S-o-b: from X, Y and Z,
> > without any need for Co-authored-by: trailer so far, and I do not
> > see any reason to change it in this project.
>
> One advantage to making a machine-readable version is that tools on the
> reading side can then count contributions, etc. For instance:
>
>   https://github.com/git/git/commit/69f272b922df153c86db520bf9b6018a9808c2a6
>
> shows all of the co-author avatars, and you can click through to their
> pages.

FWIW I really like this. It bugged me ever since that GitMerge talk (https://www.youtube.com/watch?v=usQgAy8YDVA) that we did not have any standardized way to document co-authored commits.

Show 16 quoted lines
> > If other projects wants to use such a footer, that's their choice,
> > but I am fairly negative to the idea to open the gate to unbounded
> > number of new options for new trailer lines.  We do not even have
> > such options like --acked=<acker>, --reported=<reporter>, for the
> > trailers that are actively used already (and to make sure nobody
> > misunderstands, I do not think it is a good idea to add such
> > individual options).
>
> Yeah, I'd agree that we should start first with a generic trailer line.
> 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.
Yep, and we have to start somewhere. I think this patch is a good start.

FWIW I would not even mind introducing the synonym `--co-author` for `--coauthor`. But that's just a very minor suggestion.

Ciao, Dscho

Previous: brian m. carlsonNext: Denton Liu
Message 14 of 15 in “commit: add support to provide --coauthor”
  1. 1/1 commit: add support to provide --coauthorToon Claes, Oct 8, 2019
  2. Denton LiuOct 8, 2019
  3. Phillip WoodOct 8, 2019
  4. Phillip WoodOct 8, 2019
  5. SZEDER GáborOct 9, 2019
  6. Junio C HamanoOct 9, 2019
  7. brian m. carlsonOct 9, 2019
  8. Junio C HamanoOct 9, 2019
  9. Jeff KingOct 9, 2019
  10. Toon ClaesOct 10, 2019
  11. Jeff KingOct 10, 2019
  12. Junio C HamanoOct 11, 2019
  13. brian m. carlsonOct 10, 2019
  14. Johannes SchindelinOct 10, 2019
  15. Denton LiuOct 10, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.