[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build
From: |
Paolo Bonzini |
Subject: |
[PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build |
Date: |
Fri, 29 Nov 2019 15:02:09 +0100 |
This merges my series and Peter's into one. Both the memory API and bitwise
operation APIs are covered.
Paolo Bonzini (4):
docs: import Linux kernel-doc script and extension
docs: tweak kernel-doc for QEMU coding standards
memory.h: Silence kernel-doc complaints
docs: add memory API reference
Peter Maydell (4):
docs/conf.py: Enable use of kerneldoc sphinx extension
Makefile: disable Sphinx nitpicking
bitops.h: Silence kernel-doc complaints
docs: Create bitops.rst as example of kernel-docs
Makefile | 2 +-
docs/conf.py | 7 +-
docs/devel/bitops.rst | 8 +
docs/devel/index.rst | 1 +
docs/devel/memory.rst | 5 +
docs/sphinx/kerneldoc.py | 172 +++
docs/sphinx/kernellog.py | 28 +
include/exec/memory.h | 16 +-
include/qemu/bitops.h | 52 +-
scripts/kernel-doc | 2236 ++++++++++++++++++++++++++++++++++++++
10 files changed, 2499 insertions(+), 28 deletions(-)
create mode 100644 docs/devel/bitops.rst
create mode 100644 docs/sphinx/kerneldoc.py
create mode 100644 docs/sphinx/kernellog.py
create mode 100755 scripts/kernel-doc
--
2.21.0
- [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build,
Paolo Bonzini <=
- [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards, Paolo Bonzini, 2019/11/29
- [PATCH 3/8] docs/conf.py: Enable use of kerneldoc sphinx extension, Paolo Bonzini, 2019/11/29
- [PATCH 7/8] memory.h: Silence kernel-doc complaints, Paolo Bonzini, 2019/11/29
- [PATCH 4/8] Makefile: disable Sphinx nitpicking, Paolo Bonzini, 2019/11/29
- [PATCH 6/8] docs: Create bitops.rst as example of kernel-docs, Paolo Bonzini, 2019/11/29
- [PATCH 5/8] bitops.h: Silence kernel-doc complaints, Paolo Bonzini, 2019/11/29
- [PATCH 8/8] docs: add memory API reference, Paolo Bonzini, 2019/11/29
- [PATCH 1/8] docs: import Linux kernel-doc script and extension, Paolo Bonzini, 2019/11/29
- Re: [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build, no-reply, 2019/11/29