summaryrefslogtreecommitdiffstats
path: root/Documentation/doc-guide/sphinx.rst
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2019-06-26 19:20:21 +0200
committerJonathan Corbet <corbet@lwn.net>2019-06-26 19:20:21 +0200
commitd9d7c0c497b8e2ffd9fe26cc96a49ed2d69d8b75 (patch)
treeaeed42f5b3d8d8518e7d1656215f3572630bcdbc /Documentation/doc-guide/sphinx.rst
parentkernel-doc: Don't try to mark up function names (diff)
downloadlinux-d9d7c0c497b8e2ffd9fe26cc96a49ed2d69d8b75.tar.xz
linux-d9d7c0c497b8e2ffd9fe26cc96a49ed2d69d8b75.zip
docs: Note that :c:func: should no longer be used
Now that we can mark up function() automatically, there is no reason to use :c:func: and every reason to avoid it. Adjust the documentation to reflect that fact. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide/sphinx.rst')
-rw-r--r--Documentation/doc-guide/sphinx.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index e60a56640c63..f71ddd592aaa 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -241,11 +241,14 @@ The C domain of the kernel-doc has some additional features. E.g. you can
The func-name (e.g. ioctl) remains in the output but the ref-name changed from
``ioctl`` to ``VIDIOC_LOG_STATUS``. The index entry for this function is also
-changed to ``VIDIOC_LOG_STATUS`` and the function can now referenced by:
-
-.. code-block:: rst
-
- :c:func:`VIDIOC_LOG_STATUS`
+changed to ``VIDIOC_LOG_STATUS``.
+
+Please note that there is no need to use ``c:func:`` to generate cross
+references to function documentation. Due to some Sphinx extension magic,
+the documentation build system will automatically turn a reference to
+``function()`` into a cross reference if an index entry for the given
+function name exists. If you see ``c:func:`` use in a kernel document,
+please feel free to remove it.
list tables