Commit Graph

7 Commits

Author SHA1 Message Date
Jonathan Corbet
944df7a314 docs: update the guidance for Link: tags
As stated definitively by Linus, the use of Link: tags should be limited to
situations where there is additional useful information to be found at the
far end of the link.  Update our documentation to reflect that policy, and
to remove the suggestion for a Git hook to add those tags automatically.

Link: https://lore.kernel.org/all/CAHk-=wh5AyuvEhNY9a57v-vwyr7EkPVRUKMPwj92yF_K0dJHVg@mail.gmail.com/
Cc: Linus Walleij <linus.walleij@linaro.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <87segwyc3p.fsf@trenco.lwn.net>
2025-09-15 17:22:38 -06:00
Jakub Kicinski
3afd89a459 docs: maintainers: add missing 's' in https for the base lore link
The example and the git hook use HTTPS but the text for some
reason links to the non-SSL version.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230713230510.1505201-1-kuba@kernel.org
2023-07-14 12:32:44 -06:00
Jonathan Corbet
75c33a0131 docs: Slight maintainer's guide decrufting
Get rid of some markup cruft and unneeded labels in a pair of maintainer's
manual documents.  No wording changes.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-07-14 12:31:26 -06:00
Jakub Kicinski
803fda1707 docs: maintainers: mention tag -s for signed tags
The documentation talks about -u and how to configure the default
key. It does not mention that once the default key is set one
should use the -s flag. Which is likely what most people end up
using.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20230713230606.1505458-1-kuba@kernel.org>
2023-07-14 12:18:49 -06:00
Johannes Berg
2bb19e740e Documentation: update git configuration for Link: tag
The latest version of git (2.41.0) changed the spelling
of Message-Id to Message-ID. Adjust the perl script here
to accept both spellings.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Tested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230619115533.981f6abaca01.I1960c39b1d61e8514afcef4806a450a209133187@changeid
2023-06-21 09:15:15 -06:00
Linus Walleij
291084904e Documentation: Document how to get links with git am
This adds Kees' clever apply hook to the kernel documentation so
it can be easily references when needed.

Cc: Kees Cook <keescook@chromium.org>
Link: https://lists.linuxfoundation.org/pipermail/ksummit-discuss/2019-July/006608.html
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Link: https://lore.kernel.org/r/20191118223019.81708-1-linus.walleij@linaro.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-11-19 13:13:45 -07:00
Tobin C. Harding
9727a0144b doc: add maintainer book
There is currently very little documentation in the kernel on maintainer
level tasks. In particular there are no documents on creating pull
requests to submit to Linus.

Quoting Greg Kroah-Hartman on LKML:

    Anyway, this actually came up at the kernel summit / maintainer
    meeting a few weeks ago, in that "how do I make a
    good pull request to Linus" is something we need to document.

    Here's what I do, and it seems to work well, so maybe we should turn
    it into the start of the documentation for how to do it.

(quote references: kernel summit, Europe 2017)

Create a new kernel documentation book 'how to be a maintainer'
(suggested by Jonathan Corbet). Add chapters on 'configuring git' and
'creating a pull request'.

Most of the content was written by Linus Torvalds and Greg Kroah-Hartman
in discussion on LKML. This is stated at the start of one of the
chapters and the original email thread is referenced in
'pull-requests.rst'.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-12-11 14:43:24 -07:00