forked from Minki/linux
1f57bd42b7
Mention the 'Link' tag in the section about adding URLs to the commit msg, to make it clearer they "_primarily_ [...] should be about background", as Linus recently stated (see the link below). That makes the explanation also easier to find with a text search. For the same reason and to improve comprehensibility provide an example, too. Slightly improve the text at the same time to make it more obvious developers are meant to add links to issue reports in mailing list archives, as those allow regression tracking efforts to automatically check which bugs got resolved. Move the section also downwards slightly, to reduce jumping back and forth between aspects relevant for the top and the bottom part of the commit msg. Link: https://lore.kernel.org/lkml/CAHk-=wgBhyLhQLPem1vybKNt7BKP+=qF=veBgc7VirZaXn4FUw@mail.gmail.com/ CC: Konstantin Ryabitsev <konstantin@linuxfoundation.org> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Reviewed-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org> Link: https://lore.kernel.org/r/27105768dc19b395e7c8e7a80d056d1ff9c570d0.1635152553.git.linux@leemhuis.info [jc: tweaked wording following Konstantin's recommendation] Signed-off-by: Jonathan Corbet <corbet@lwn.net> |
||
|---|---|---|
| .. | ||
| 1.Intro.rst | ||
| 2.Process.rst | ||
| 3.Early-stage.rst | ||
| 4.Coding.rst | ||
| 5.Posting.rst | ||
| 6.Followthrough.rst | ||
| 7.AdvancedTopics.rst | ||
| 8.Conclusion.rst | ||
| adding-syscalls.rst | ||
| applying-patches.rst | ||
| botching-up-ioctls.rst | ||
| changes.rst | ||
| clang-format.rst | ||
| code-of-conduct-interpretation.rst | ||
| code-of-conduct.rst | ||
| coding-style.rst | ||
| deprecated.rst | ||
| development-process.rst | ||
| email-clients.rst | ||
| embargoed-hardware-issues.rst | ||
| howto.rst | ||
| index.rst | ||
| kernel-docs.rst | ||
| kernel-driver-statement.rst | ||
| kernel-enforcement-statement.rst | ||
| license-rules.rst | ||
| magic-number.rst | ||
| maintainer-handbooks.rst | ||
| maintainer-pgp-guide.rst | ||
| maintainer-tip.rst | ||
| maintainers.rst | ||
| management-style.rst | ||
| programming-language.rst | ||
| stable-api-nonsense.rst | ||
| stable-kernel-rules.rst | ||
| submit-checklist.rst | ||
| submitting-drivers.rst | ||
| submitting-patches.rst | ||
| volatile-considered-harmful.rst | ||