]> git.karo-electronics.de Git - linux-beck.git/commit
doc-rst:c-domain: ref-name of a function declaration
authorMarkus Heiser <markus.heiser@darmarIT.de>
Mon, 15 Aug 2016 14:08:25 +0000 (16:08 +0200)
committerJonathan Corbet <corbet@lwn.net>
Mon, 22 Aug 2016 21:19:22 +0000 (15:19 -0600)
commit2c645cd7c4a0d4b35da1e43ec3a5b55a64038157
treec18c69bd8fca8a662434864c714b0c884642a85b
parente8f5c617f26626ef4915ffa176f4ae02c9e08531
doc-rst:c-domain: ref-name of a function declaration

Add option 'name' to the "c:function:" directive.  With option 'name'
the ref-name of a function can be modified. E.g.::

    .. c:function:: int ioctl( int fd, int request )
       :name: VIDIOC_LOG_STATUS

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::

    :c:func:`VIDIOC_LOG_STATUS`

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/kernel-documentation.rst
Documentation/sphinx/cdomain.py