Searched hist:"556 aa6d5d9616ccfc0099c40dc239157f50ee776" (Results 1 – 1 of 1) sorted by relevance
/linux/Documentation/sphinx/ |
H A D | cdomain.py | diff 556aa6d5d9616ccfc0099c40dc239157f50ee776 Mon Aug 15 16:08:26 CEST 2016 Markus Heiser <markus.heiser@darmarIT.de> doc-rst: moved *duplicate* warnings to nitpicky mode
Moved the *duplicate C object description* warnings for function declarations in the nitpicky mode. In nitpick mode, you can suppress those warnings (e.g. ioctl) with::
nitpicky = True nitpick_ignore = [ ("c:func", "ioctl"), ]
See Sphinx documentation for the config values for ``nitpick`` and ``nitpick_ignore`` [1].
With this change all the ".. cpp:function:: int ioctl(..)" descriptions (found in the media book) can be migrated to ".. c:function:: int ioctl(..)", without getting any warnings. E.g.::
.. cpp:function:: int ioctl( int fd, int request, struct cec_event *argp )
.. c:function:: int ioctl( int fd, int request, struct cec_event *argp )
The main effect, is that we get those *CPP-types* back into Sphinx's C- namespace and we need no longer to distinguish between c/cpp references, when we refer a function like the ioctl.
[1] http://www.sphinx-doc.org/en/stable/config.html?highlight=nitpick#confval-nitpicky
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|