Hello,
this is an attempt at including kernel-doc, with small tweaks (see patch
2) to support QEMU's doc comment format, in the Sphinx documentation pipeline.
The ugly part is patch 3, which disables Sphinx's "nitpicking" (warn on
invalid cross-reference) mode. It would probably be possible to use
the nitpick_ignore configuration entry instead.
Paolo
Paolo Bonzini (6):
docs: import Linux kernel-doc script and extension
docs: tweak kernel-doc for QEMU coding standards
docs: disable sphinx warning about missing cross references
memory: adjust API documentation to (modified) kerneldoc format
docs: add memory API reference
memory: include MemoryListener documentation and some missing function
parameters
Makefile | 2 +-
docs/conf.py | 7 +-
docs/devel/memory.rst | 5 +
docs/sphinx/kernellog.py | 28 +
include/exec/memory.h | 227 +++-
scripts/kernel-doc | 2236 ++++++++++++++++++++++++++++++++++++++
6 files changed, 2495 insertions(+), 10 deletions(-)
create mode 100644 docs/sphinx/kernellog.py
create mode 100755 scripts/kernel-doc
--
2.21.0
