alistair23-linux/Documentation/sphinx
Markus Heiser 556aa6d5d9 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>
2016-08-22 15:19:38 -06:00
..
cdomain.py doc-rst: moved *duplicate* warnings to nitpicky mode 2016-08-22 15:19:38 -06:00
convert_template.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
kernel-doc.py doc-rst: kernel-doc directive, fix state machine reporter 2016-07-20 16:51:12 -06:00
kernel_include.py doc-rst: add kernel-include directive 2016-07-08 09:31:04 -03: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