Skip to content

Commit bf33a9d

Browse files
knurdJonathan Corbet
authored andcommitted
docs: 5.Posting.rst: describe Fixes: and Link: tags
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 <[email protected]> CC: Konstantin Ryabitsev <[email protected]> Link: https://lore.kernel.org/r/c4a5f5e25fa84b26fd383bba6eafde4ab57c9de7.1641314856.git.linux@leemhuis.info Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 689d801 commit bf33a9d

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

Documentation/process/5.Posting.rst

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -197,14 +197,29 @@ the build process, for example, or editor backup files) in the patch. The
197197
file "dontdiff" in the Documentation directory can help in this regard;
198198
pass it to diff with the "-X" option.
199199

200-
The tags mentioned above are used to describe how various developers have
201-
been associated with the development of this patch. They are described in
202-
detail in
203-
the :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
204-
document; what follows here is a brief summary. Each of these lines has
205-
the format:
200+
The tags already briefly mentioned above are used to provide insights how
201+
the patch came into being. They are described in detail in the
202+
:ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
203+
document; what follows here is a brief summary.
206204

207-
::
205+
One tag is used to refer to earlier commits which introduced problems fixed by
206+
the patch::
207+
208+
Fixes: 1f2e3d4c5b6a ("The first line of the commit specified by the first 12 characters of its SHA-1 ID")
209+
210+
Another tag is used for linking web pages with additional backgrounds or
211+
details, for example a report about a bug fixed by the patch or a document
212+
with a specification implemented by the patch::
213+
214+
Link: https://example.com/somewhere.html optional-other-stuff
215+
216+
Many maintainers when applying a patch also add this tag to link to the
217+
latest public review posting of the patch; often this is automatically done
218+
by tools like b4 or a git hook like the one described in
219+
'Documentation/maintainer/configure-git.rst'.
220+
221+
A third kind of tag is used to document who was involved in the development of
222+
the patch. Each of these uses this format::
208223

209224
tag: Full Name <email address> optional-other-stuff
210225

0 commit comments

Comments
 (0)