summaryrefslogtreecommitdiffstats
path: root/Documentation/doc-guide/sphinx.rst
diff options
context:
space:
mode:
authorVegard Nossum <vegard.nossum@oracle.com>2023-10-27 13:54:20 +0200
committerJonathan Corbet <corbet@lwn.net>2023-11-17 21:13:24 +0100
commit86b17aaf2e887355e4f70dd9c4897f6a06fa9b32 (patch)
tree6839ba275120f5aa946bb2c8f81ef43bf3481b2b /Documentation/doc-guide/sphinx.rst
parentMerge branch 'vegard' into docs-mw (diff)
downloadlinux-86b17aaf2e887355e4f70dd9c4897f6a06fa9b32.tar.xz
linux-86b17aaf2e887355e4f70dd9c4897f6a06fa9b32.zip
docs: automarkup: linkify git revs
There aren't a ton of references to commits in the documentation, but they do exist, and we can use automarkup to linkify them to make them easier to follow. Use something like this to find references to commits: git grep -P 'commit.*[0-9a-f]{8,}' Documentation/ Also fix a few of these to standardize on the exact format that is already used in changelogs. Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20231027115420.205279-1-vegard.nossum@oracle.com
Diffstat (limited to 'Documentation/doc-guide/sphinx.rst')
-rw-r--r--Documentation/doc-guide/sphinx.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index cd8ad7904491..bb7971643fcf 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -435,6 +435,15 @@ path.
For information on cross-referencing to kernel-doc functions or types, see
Documentation/doc-guide/kernel-doc.rst.
+Referencing commits
+~~~~~~~~~~~~~~~~~~~
+
+References to git commits are automatically hyperlinked given that they are
+written in one of these formats::
+
+ commit 72bf4f1767f0
+ commit 72bf4f1767f0 ("net: do not leave an empty skb in write queue")
+
.. _sphinx_kfigure:
Figures & Images