public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox•com>
To: Jonathan Tan <jonathantanmy@google•com>
Cc: "Stefan Beller" <sbeller@google•com>,
	"git@vger•kernel.org" <git@vger•kernel.org>,
	"Jakub Narębski" <jnareb@gmail•com>
Subject: Re: [PATCH v3 5/6] trailer: allow non-trailers in trailer block
Date: Tue, 18 Oct 2016 09:36:22 -0700	[thread overview]
Message-ID: <xmqqbmyhr4vt.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <cb622421-1857-d136-2618-ec62d438790d@google.com> (Jonathan Tan's message of "Mon, 17 Oct 2016 19:02:46 -0700")

Jonathan Tan <jonathantanmy@google•com> writes:

>>     * rs/c-auto-resets-attributes:
>>       pretty: avoid adding reset for %C(auto) if output is empty
>>
>> And neither of the two colon containing line remotely resembles how
>> a typical RFC-822 header is formatted.  So that may serve as a hint
>> to how we can tighten it without introducing false negative.
>
> The only "offending" character is the space (according to RFC 822),
> but that sounds like a good rule to have.

I suspect that we should be willing to deviate from the letter of
RFC to reject misidentification.  I saw things like

	Thanks to: Jonathan Tan <jt@host•xz>
	Signed-off-by: A U Thor <au@th•or>

in the wild (notice the SP between Thanks and to), for example.
Rejecting leading whitespace as a line that does *not* start the
header (hence its colon does not count) may be a good compromise.

> I think that "Signed-off-by:" is not guaranteed to be
> present.

But do we really care about that case where there is no S-o-b:?  I
personally do not think so.

> Defining a trailer line as "a line starting with a token,
> then optional whitespace, then separator", maybe the following rule:
> - at least one trailer line generated by Git ("(cherry picked by" or
> "Signed-off-by") or configured in the "trailer" section in gitconfig
> OR
> - at least 3/4 logical trailer lines (I'm wondering if this should be
> 100% trailer lines)

I'd strongly suggest turning that OR to AND.  We will not safely be
able to write a commit log message that describes how S-o-b lines
are handled in its last paragraph otherwise.

I do not care too deeply about 3/4, but I meant to allow 75% cruft
but no more than that, and the fact that the threashold is set at
way more than 50% is important.  IOW, if you have

	Ordinary log message here...

	S-o-b: A U Thor <au@th•or>
	[a short description that is typically a single liner
        in the real world use pattern we saw in the world, but
	could overflow to become multi line cruft]
	S-o-b: R E Layer <re@lay•er>

"last paragraph" is 5 lines long, among which 60% are cruft that is
below the 75% threshold, and "am -s" can still add the S-o-b of the
committer at the end of that existing last paragraph.  Making it too
strict would raise the false negative ratio.

  reply	other threads:[~2016-10-18 16:36 UTC|newest]

Thread overview: 67+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-12  1:23 [PATCH 0/5] allow non-trailers and multiple-line trailers Jonathan Tan
2016-10-12  1:23 ` [PATCH 1/5] trailer: use singly-linked list, not doubly Jonathan Tan
2016-10-12  6:24   ` Junio C Hamano
2016-10-12 15:38   ` Christian Couder
2016-10-12 17:26     ` Jeff King
2016-10-12  1:23 ` [PATCH 2/5] trailer: streamline trailer item create and add Jonathan Tan
2016-10-12  1:23 ` [PATCH 3/5] trailer: make args have their own struct Jonathan Tan
2016-10-12  1:23 ` [PATCH 4/5] trailer: allow non-trailers in trailer block Jonathan Tan
2016-10-12  1:23 ` [PATCH 5/5] trailer: support values folded to multiple lines Jonathan Tan
2016-10-12  6:23   ` Junio C Hamano
2016-10-12 23:40 ` [PATCH v2 0/6] allow non-trailers and multiple-line trailers Jonathan Tan
2016-10-12 23:40   ` [PATCH v2 1/6] trailer: improve const correctness Jonathan Tan
2016-10-12 23:40   ` [PATCH v2 2/6] trailer: use list.h for doubly-linked list Jonathan Tan
2016-10-14 17:29     ` Jakub Narębski
2016-10-14 18:27     ` Junio C Hamano
2016-10-12 23:40   ` [PATCH v2 3/6] trailer: streamline trailer item create and add Jonathan Tan
2016-10-12 23:40   ` [PATCH v2 4/6] trailer: make args have their own struct Jonathan Tan
2016-10-12 23:40   ` [PATCH v2 5/6] trailer: allow non-trailers in trailer block Jonathan Tan
2016-10-12 23:40   ` [PATCH v2 6/6] trailer: support values folded to multiple lines Jonathan Tan
2016-10-14 17:37 ` [PATCH v3 0/6] allow non-trailers and multiple-line trailers Jonathan Tan
2016-10-14 17:37   ` [PATCH v3 1/6] trailer: improve const correctness Jonathan Tan
2016-10-17 22:49     ` Stefan Beller
2016-10-14 17:37   ` [PATCH v3 2/6] trailer: use list.h for doubly-linked list Jonathan Tan
2016-10-14 17:38   ` [PATCH v3 3/6] trailer: streamline trailer item create and add Jonathan Tan
2016-10-17 23:01     ` Stefan Beller
2016-10-14 17:38   ` [PATCH v3 4/6] trailer: make args have their own struct Jonathan Tan
2016-10-17 23:20     ` Stefan Beller
2016-10-18 16:05       ` Junio C Hamano
2016-10-14 17:38   ` [PATCH v3 5/6] trailer: allow non-trailers in trailer block Jonathan Tan
2016-10-18  0:49     ` Stefan Beller
2016-10-18  1:42       ` Junio C Hamano
2016-10-18  2:02         ` Jonathan Tan
2016-10-18 16:36           ` Junio C Hamano [this message]
2016-10-19 18:00             ` Jonathan Tan
2016-10-19 19:24               ` Junio C Hamano
2016-10-14 17:38   ` [PATCH v3 6/6] trailer: support values folded to multiple lines Jonathan Tan
2016-10-18  0:55     ` Stefan Beller
2016-10-20 21:39 ` [PATCH v4 0/8] allow non-trailers and multiple-line trailers Jonathan Tan
2016-10-20 21:39   ` [PATCH v4 1/8] trailer: improve const correctness Jonathan Tan
2016-10-20 21:39   ` [PATCH v4 2/8] trailer: use list.h for doubly-linked list Jonathan Tan
2016-10-20 21:39   ` [PATCH v4 3/8] trailer: streamline trailer item create and add Jonathan Tan
2016-10-20 21:39   ` [PATCH v4 4/8] trailer: make args have their own struct Jonathan Tan
2016-10-20 21:39   ` [PATCH v4 5/8] trailer: clarify failure modes in parse_trailer Jonathan Tan
2016-10-20 22:07     ` Stefan Beller
2016-10-20 22:14       ` Junio C Hamano
2016-10-20 22:40         ` Jonathan Tan
2016-10-20 22:45           ` Junio C Hamano
2016-10-20 22:49             ` Jonathan Tan
2016-10-21  0:18               ` Junio C Hamano
2016-10-22 13:07                 ` Christian Couder
2016-10-22 16:19                   ` Junio C Hamano
2016-10-22  9:29             ` Christian Couder
2016-10-20 22:45           ` Jonathan Tan
2016-10-20 21:39   ` [PATCH v4 6/8] trailer: allow non-trailers in trailer block Jonathan Tan
2016-10-20 21:39   ` [PATCH v4 7/8] trailer: forbid leading whitespace in trailers Jonathan Tan
2016-10-20 21:39   ` [PATCH v4 8/8] trailer: support values folded to multiple lines Jonathan Tan
2016-10-21 17:54 ` [PATCH v5 0/8] allow non-trailers and multiple-line trailers Jonathan Tan
2016-10-21 17:54   ` [PATCH v5 1/8] trailer: improve const correctness Jonathan Tan
2016-10-21 17:54   ` [PATCH v5 2/8] trailer: use list.h for doubly-linked list Jonathan Tan
2016-10-21 17:54   ` [PATCH v5 3/8] trailer: streamline trailer item create and add Jonathan Tan
2016-10-21 17:54   ` [PATCH v5 4/8] trailer: make args have their own struct Jonathan Tan
2016-10-21 17:55   ` [PATCH v5 5/8] trailer: clarify failure modes in parse_trailer Jonathan Tan
2016-10-21 17:55   ` [PATCH v5 6/8] trailer: allow non-trailers in trailer block Jonathan Tan
2016-10-21 17:55   ` [PATCH v5 7/8] trailer: forbid leading whitespace in trailers Jonathan Tan
2016-10-21 17:55   ` [PATCH v5 8/8] trailer: support values folded to multiple lines Jonathan Tan
2016-10-21 23:59   ` [PATCH v5 0/8] allow non-trailers and multiple-line trailers Junio C Hamano
2016-10-22  0:06     ` Stefan Beller

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=xmqqbmyhr4vt.fsf@gitster.mtv.corp.google.com \
    --to=gitster@pobox$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=jnareb@gmail$(echo .)com \
    --cc=jonathantanmy@google$(echo .)com \
    --cc=sbeller@google$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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