Files
linux/Documentation
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
..
2016-08-07 14:41:02 -06:00
2016-05-31 16:41:55 +08:00
2016-08-18 15:31:56 -06:00
2016-08-18 15:31:56 -06:00
2016-06-03 13:31:37 -06:00
2016-06-14 16:01:00 -07:00
2015-11-30 12:14:12 +00:00
2016-06-30 13:07:33 -06:00
2016-06-07 22:57:10 +02:00
2016-06-07 22:57:10 +02:00
2016-05-17 14:48:04 +02:00
2016-04-28 08:02:36 -06:00