git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>
To: "Jeff King" <peff@peff.net>
Cc: "Patrick Steinhardt" <ps@pks.im>,
	git@vger.kernel.org, "Adam Dinwoodie" <adam@dinwoodie.org>,
	"Ramsay Jones" <ramsay@ramsayjones.plus.com>,
	"Taylor Blau" <me@ttaylorr.com>
Subject: Comment trailers vs. bracketed lines
Date: Sun, 20 Oct 2024 19:08:24 +0200	[thread overview]
Message-ID: <ae56dc14-bbae-4d5e-a890-20735131d484@app.fastmail.com> (raw)
In-Reply-To: <20241019212135.GB589728@coredump.intra.peff.net>

Hi Peff

(editing the subject now which I intended to do from the start)

On Sat, Oct 19, 2024, at 23:21, Jeff King wrote:
>> On Fri, Oct 18, 2024, at 07:29, Jeff King wrote:
>> […]
>
> I assigned authorship to Ramsay, so my name is not otherwise mentioned,
> but appears in the signoff. So it was a way of mentioning what I
> contributed (both for credit, but also in case anybody has questions
> later).
>
> I guess "Commit-message-by:" would work, too. ;)

I’ve done that when someone has given me a non-descript diff. :)

> I think in the usual trailer order, it would be:
>
>   Signed-off-by: Ramsay
>   [jk: add commit message]
>   Signed-off-by: me
>
> but I didn't want to forge his S-o-b without asking first.

I’ve seen those brackets in the log.  They used to happen with some
regularity.  At first it made sense since you need a free-form area to
both comment and tell everyone that you left the comment.  And a trailer
doesn’t make sense for that, I thought.[1]

But thinking about the signoff requirement: you already have all the
information you need from the next trailer, namely the signoff.  In
other words this:

    [kh: Added tests]
    Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>

Has the same information as this:

    Comment: Added tests
    Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>

Because the signoff order tells you who left the comment.  So I was
wondering to myself why this uniform approach wasn’t used.

† 1: Since the brackets become “non-trailer values” or something
   (git-interpret-trailers(1)), i.e. the discarded parts of the trailer
   block

  reply	other threads:[~2024-10-20 17:08 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-16 14:21 [PATCH] builtin/credential-cache--daemon: fix error when "exit"ing on Cygwin Patrick Steinhardt
2024-10-16 14:55 ` Jeff King
2024-10-16 15:09   ` Jeff King
2024-10-16 15:39     ` Ramsay Jones
2024-10-16 20:28     ` Taylor Blau
2024-10-17  2:33       ` Jeff King
2024-10-17  8:46         ` Patrick Steinhardt
2024-10-17 22:58           ` Ramsay Jones
2024-10-18  4:36             ` Patrick Steinhardt
2024-10-17 20:54         ` Taylor Blau
2024-10-16 15:12 ` Ramsay Jones
2024-10-18  4:36 ` [PATCH v2] " Patrick Steinhardt
2024-10-18  5:29   ` [PATCH] credential-cache: treat ECONNABORTED like ECONNRESET Jeff King
2024-10-18  5:32     ` Patrick Steinhardt
2024-10-18 15:33     ` Ramsay Jones
2024-10-18 21:17       ` Taylor Blau
2024-10-18 21:27     ` Kristoffer Haugsbakk
2024-10-19 21:21       ` Jeff King
2024-10-20 17:08         ` Kristoffer Haugsbakk [this message]
2025-05-07 16:41           ` Comment trailers vs. bracketed lines Kristoffer Haugsbakk
2025-05-08 20:24             ` Jeff King
2025-05-07 19:20           ` Junio C Hamano

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ae56dc14-bbae-4d5e-a890-20735131d484@app.fastmail.com \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=adam@dinwoodie.org \
    --cc=git@vger.kernel.org \
    --cc=me@ttaylorr.com \
    --cc=peff@peff.net \
    --cc=ps@pks.im \
    --cc=ramsay@ramsayjones.plus.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.
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 NNTP newsgroup(s).