[RFC PATCH 0/5] doc-rst: improvements Sphinx's C-domain

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: Markus Heiser <markus.heiser@xxxxxxxxxxx>

Hi,

this is my approach to eliminate some distortions we have with the c/cpp Sphinx
domains. The C domain is simple: it assumes that all functions, enums, etc
are global, e. g. there should be just one function called "ioctl", or "open".
With the 'name' option e.g.:

    .. c:function:: int ioctl( int fd, int request )
       :name: VIDIOC_LOG_STATUS

we can rename those functions. Another nice feature around this *global*
namespace topic is, that the *duplicate C object description* warnings for
function declarations are moved to the nitpicky mode.

Thanks for your comments

  -- Markus --

Markus Heiser (5):
  doc-rst: add boilerplate to customize c-domain
  doc-rst:c-domain: ref-name of a function declaration
  doc-rst: moved *duplicate* warnings to nitpicky mode
  doc-rst: Revert "kernel-doc: fix handling of address_space tags"
  doc-rst: migrate ioctl CEC_DQEVENT to c-domain

 Documentation/conf.py                            |   2 +-
 Documentation/kernel-documentation.rst           |  29 +++++++
 Documentation/media/uapi/cec/cec-func-open.rst   |   2 +-
 Documentation/media/uapi/cec/cec-ioc-dqevent.rst |   5 +-
 Documentation/sphinx/cdomain.py                  | 102 +++++++++++++++++++++++
 scripts/kernel-doc                               |   3 -
 6 files changed, 136 insertions(+), 7 deletions(-)
 create mode 100644 Documentation/sphinx/cdomain.py

-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux