diff options
author | Markus Heiser <markus.heiser@darmarIT.de> | 2016-08-15 17:08:26 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-08-23 00:19:38 +0300 |
commit | 556aa6d5d9616ccfc0099c40dc239157f50ee776 (patch) | |
tree | 4df7db8dc75f1c3401446fb39ef27105f963f544 /scripts/kernel-doc | |
parent | 2c645cd7c4a0d4b35da1e43ec3a5b55a64038157 (diff) | |
download | linux-556aa6d5d9616ccfc0099c40dc239157f50ee776.tar.xz |
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>
Diffstat (limited to 'scripts/kernel-doc')
0 files changed, 0 insertions, 0 deletions