Kernel/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2025-01-03 19:55:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: 5.Posting.rst: describe Fixes: and Link: tags

Browse Source 
Explain Fixes: and Link: tags in Documentation/process/5.Posting.rst,
which are missing in this file for unknown reasons and only described in
Documentation/process/submitting-patches.rst.

Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
CC: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Link: https://lore.kernel.org/r/c4a5f5e25fa84b26fd383bba6eafde4ab57c9de7.1641314856.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Thorsten Leemhuis 2022-01-04 17:53:33 +01:00 committed by Jonathan Corbet
parent 689d8014d9
commit bf33a9d42d
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Documentation/process/5.Posting.rst
View File

@ -197,14 +197,29 @@ the build process, for example, or editor backup files) in the patch. The
file "dontdiff" in the Documentation directory can help in this regard; file "dontdiff" in the Documentation directory can help in this regard;
pass it to diff with the "-X" option. pass it to diff with the "-X" option.
The tags mentioned above are used to describe how various developers have The tags already briefly mentioned above are used to provide insights how
been associated with the development of this patch. They are described in the patch came into being. They are described in detail in the
detail in :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
the :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` document; what follows here is a brief summary.
document; what follows here is a brief summary. Each of these lines has
the format:
:: One tag is used to refer to earlier commits which introduced problems fixed by
the patch::
Fixes: 1f2e3d4c5b6a ("The first line of the commit specified by the first 12 characters of its SHA-1 ID")
Another tag is used for linking web pages with additional backgrounds or
details, for example a report about a bug fixed by the patch or a document
with a specification implemented by the patch::
Link: https://example.com/somewhere.html optional-other-stuff
Many maintainers when applying a patch also add this tag to link to the
latest public review posting of the patch; often this is automatically done
by tools like b4 or a git hook like the one described in
'Documentation/maintainer/configure-git.rst'.
A third kind of tag is used to document who was involved in the development of
the patch. Each of these uses this format::
tag: Full Name <email address> optional-other-stuff tag: Full Name <email address> optional-other-stuff