From: Russell King - ARM Linux admin <linux@armlinux.org.uk>
To: Linus Walleij <linus.walleij@linaro.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Link: documentation seems to be misplaced
Date: Thu, 12 Dec 2019 13:50:16 +0000 [thread overview]
Message-ID: <20191212135016.GH25745@shell.armlinux.org.uk> (raw)
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
next reply other threads:[~2019-12-12 13:50 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-12 13:50 Russell King - ARM Linux admin [this message]
2019-12-16 9:39 ` Link: documentation seems to be misplaced Linus Walleij
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=20191212135016.GH25745@shell.armlinux.org.uk \
--to=linux@armlinux.org.uk \
--cc=corbet@lwn.net \
--cc=linus.walleij@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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).