2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-16 09:13:55 +08:00
linux-next/Documentation/sphinx
Markus Heiser 2c645cd7c4 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>
2016-08-22 15:19:22 -06:00
..
cdomain.py doc-rst:c-domain: ref-name of a function declaration 2016-08-22 15:19:22 -06:00
convert_template.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
kernel_include.py doc-rst: add kernel-include directive 2016-07-08 09:31:04 -03:00
kernel-doc.py doc-rst: kernel-doc directive, fix state machine reporter 2016-07-20 16:51:12 -06:00
load_config.py doc-rst: generic way to build only sphinx sub-folders 2016-08-14 11:51:51 -06:00
parse-headers.pl docs-rst: parse-heraders.pl: escape LaTeX characters 2016-08-18 16:42:07 -06:00
post_convert.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
rstFlatTable.py doc-rst: flat-table directive - initial implementation 2016-06-30 12:58:33 -06:00
tmplcvt sphinx: cheesy script to convert .tmpl files 2016-05-30 13:38:53 +03:00