Skip to contentSkip to conversation

docs: submitting-patches: Fix crossref to 'The canonical patch format'

PATCH Applied Akira Yokosawa 2 participants 2 messages Apr 27, 2022 – Apr 28, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: submitting-patches: Fix crossref to 'The canonical patch format'

The reference to explicit_in_reply_to is pointless as when the reference was added in the form of "#15" [1], Section 15) was "The canonical patch format".
The reference of "#15" had not been properly updated in a couple of reorganizations during the plain-text SubmittingPatches era.

Fix it by using the_canonical_patch_format.

[1]: 2ae19acaa50a ("Documentation: Add "how to write a good patch summary" to SubmittingPatches")

Fixes 5903019b2a5e ("Documentation/SubmittingPatches: convert it to ReST markup")
Fixes 9b2c76777acc ("Documentation/SubmittingPatches: enrich the Sphinx output")
Cc Jonathan Corbet <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 Documentation/process/submitting-patches.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/process/submitting-patches.rst +1 -1
index 9bb4e8c0f635..bf5ead743ccf 100644
@@ -77,7 +77,7 @@ as you intend it to.
 
 The maintainer will thank you if you write your patch description in a
 form which can be easily pulled into Linux's source code management
-system, ``git``, as a "commit log".  See :ref:`explicit_in_reply_to`.
+system, ``git``, as a "commit log".  See :ref:`the_canonical_patch_format`.
 
 Solve only one problem per patch.  If your description starts to get
 long, that's a sign that you probably need to split up your patch.

base-commit: f5461124d59bfb62bd9e231ee64cbaf757343ad5

Signature · 1 line
2.25.1
maintainer Applied
#1 lore raw
Quoted 16 lines · Akira Yokosawa

The reference to explicit_in_reply_to is pointless as when the reference was added in the form of "#15" [1], Section 15) was "The canonical patch format".
The reference of "#15" had not been properly updated in a couple of reorganizations during the plain-text SubmittingPatches era.

Fix it by using the_canonical_patch_format.

[1]: 2ae19acaa50a ("Documentation: Add "how to write a good patch summary" to SubmittingPatches")

Fixes 5903019b2a5e ("Documentation/SubmittingPatches: convert it to ReST markup")
Fixes 9b2c76777acc ("Documentation/SubmittingPatches: enrich the Sphinx output")
Cc Jonathan Corbet <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
Quoted 3 lines
---
 Documentation/process/submitting-patches.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks.

jon