Re: [PATCH] docs: Document the Link: tag formally

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Dec 16, 2019 at 09:22:55AM -0700, Jonathan Corbet wrote:
> On Mon, 16 Dec 2019 17:13:20 +0200
> Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx> wrote:
> 
> > The *only* question is, whether we should both use the tag Foo: for the
> > different meanings and different workflows, or whether one should use
> > Foo: and the other should use Bar:.
> 
> This is, of course, a part of the wider discussion on patch tracking IDs
> and such; I kind of doubt that this relatively small group can resolve
> it for the community as a whole.  It seems to be agreed that it's good
> for a patch submission to reference previous postings; I'm not sure that
> we've decided on Link: as the way to do that.

I believe that at least amongst the maintainers at the Maintainer's
Summit and on the follow-on workflows@xxxxxxxxxxxxxxx, there is
general consensus for *maintainers* to add a

	Link: https://lore.kernel.org/r/...

tag to the patch that they are accepting into their trees.  There are
even some git hook scripts being circulated which automate this.

What there isn't consensus yet on is a way for patch *submitters* to
reference earler versions of a particular patch.  There is one school
of thought saying that you just match on subject lines, looking for
V<n-1>: commit description to find it.  There are others who don't
like this, because it requires manual searching work, and it doesn't
handle the case where a patch gets split, or merged, or where the
patch description is modified for clarity's sake.

Another school of thought is just keeping the V1, V2, V3, etc.,
versions of the patch as replies to earlier one, so they can be found
via e-mail chaining.  Some people believe this gets ugly, especially
for patches which go through a large number of revisions, and for
patch series with a large number of patches.


What *I've* been doing for ext4 is in the Vn+1 update of a patch, I've
been manually adding a:

Previous-Version-Link: https://lore.kernel.org/r/...

to the commit before mailing it out, and trusting that the maintainer
(me, myself, and I :-) will strip out the Previous-Version-Link: and
adding a Link: trailer to the final version on the mailing list.

This allows someone who is doing code archeology to find the mailing
list reference via the Link: tag in the git tree, and that version of
the patch in the mailing list archive will have a
Previous-Version-Link in the previous version of the commit, going all
the way back to the V1 version of the commit.  That is, the
Previous-Version-Link: trailer never appears in the git commit which
is pushed to Linus; but it *is* in all but the first version of the
patch in the mailing list.

I think this scheme is perfect, without flaw, and Solomonic in meeting
the needs for people to be able to find all of the various versions of
the patch and its discussions while not leaving extra hair in the git
commit found in the repository.  But, I'd also be the first to admit
that it's not general community consensus at this point.  :-)


> That creates a bit of a problem for me; I don't want to be trying to
> create community policy through the docs; I'd rather accept patches that
> I know reflect an existing consensus.

Yeah, I think it's too early at this point for anythig in
submitting-patches.  It may or may not be too early to put in the git
hook automation for automatically adding a pointer to the version of
the patch which the maintainer is actually pulling her repository
using "git am", though.

I'd also suggest redirecting discussions about how to annotate commits
to find previous versions of patches to the workflows@xxxxxxxxxxxxxxx
list; that's where most of the discussions on this topic have taken
place since Lisbon.

Cheers,

					- Ted



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux