diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2019-06-28 09:02:55 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2019-06-28 09:02:55 -0600 |
| commit | 8abc2a12c83b42cba6e7ac38cf6178585ae1783e (patch) | |
| tree | 50fcf5a0ac277d98d22d67aaeb243d9e85c90bc6 /Documentation/doc-guide | |
| parent | 49872a1cfceae38a98ee690e6c860d1cf628364e (diff) | |
| parent | d9d7c0c497b8e2ffd9fe26cc96a49ed2d69d8b75 (diff) | |
Merge branch 'automarkup' into docs-next
Bring in (finally) automatic markup of function() so we need not load up
our docs with ugly c:func: annotations.
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/sphinx.rst | 13 |
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 |