[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Date: Thu, 12 Dec 2019 13:50:16 +0000
From: Russell King - ARM Linux admin <linux@...linux.org.uk>
To: Linus Walleij <linus.walleij@...aro.org>
Cc: Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
linux-doc@...r.kernel.org
Subject: Link: documentation seems to be misplaced
Hi,
It seems that the documentation for the Link: attribute in commit
messages is misplaced in the Documentation/ subtree.
There are two workflows:
1) maintainer committing external patches that have come from a
mailing list.
2) maintainer committing local patches that have been discussed on
a mailing list.
While the current documentation seems to target initial setup for
new people becoming maintainers, but it is way less obvious for
existing maintainers or for case 2 - I came across this because I
wanted to add a Link: tag for a discussion on a patch I'd posted,
and could find nothing to describe it. My grep for it failed:
grep Link: Documentation/*/*ubmitting*
Surely, the format of the Link: tag should be documented in the
submitting-patches document with all the other attributations that
we define in a commit message, with a reference to that from
Documentation/maintainer/configure-git.rst ?
Thanks to Jiri Kosina for pointing out that it is in configure-git.rst.
--
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTC broadband for 0.8mile line in suburbia: sync at 12.1Mbps down 622kbps up
According to speedtest.net: 11.9Mbps down 500kbps up
Powered by blists - more mailing lists