31 Mar, 2017

1 commit

• c46988aef   Use sphinx.version_info directly instead of parsing ... Browse Code »

  Using the development version of sphinx caused the parsing of the
  version to fail.

  Signed-off-by: Rémy Léone
  Signed-off-by: Jonathan Corbet

  Rémy Léone

  2017-03-31 23:19:37 +0800  

16 Sep, 2016

2 commits

• 56cd86928   doc-rst:c-domain: function-like macros arguments ... Browse Code »

  Handle signatures of function-like macros well. Don't try to deduce
  arguments types of function-like macros.

  Signed-off-by: Markus Heiser
  Signed-off-by: Jonathan Corbet

  Markus Heiser

  2016-09-16 23:53:40 +0800  
• b495360e3   doc-rst:c-domain: fix sphinx version incompatibility ... Browse Code »

  The self.indexnode's tuple has changed in sphinx version 1.4, from a
  former 4 element tuple to a 5 element tuple.

  https://github.com/sphinx-doc/sphinx/commit/e6a5a3a92e938fcd75866b4227db9e0524d58f7c

  Signed-off-by: Markus Heiser
  Signed-off-by: Jonathan Corbet

  Markus Heiser

  2016-09-16 23:53:23 +0800  

23 Aug, 2016

3 commits

• 556aa6d5d   doc-rst: moved *duplicate* warnings to nitpicky mode ... Browse Code »

  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
  Signed-off-by: Jonathan Corbet

  Markus Heiser

  2016-08-23 05:19:38 +0800  
• 2c645cd7c   doc-rst:c-domain: ref-name of a function declaration ... Browse Code »

  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
  Signed-off-by: Jonathan Corbet

  Markus Heiser

  2016-08-23 05:19:22 +0800  
• e8f5c617f   doc-rst: add boilerplate to customize c-domain ... Browse Code »

  Add a sphinx-extension to customize the sphinx c-domain. No functional
  changes right yet, just the boilerplate code.

  Signed-off-by: Markus Heiser
  [ jc: coding-style tweak ]
  Signed-off-by: Jonathan Corbet

  Markus Heiser

  2016-08-23 05:19:15 +0800