[RFC,06/10] docs: Create bitops.rst as example of kernel-docs

Message ID 20190521122519.12573-7-peter.maydell@linaro.org
State New
Headers show
Series
  • Add kernel-doc support to our Sphinx setup
Related show

Commit Message

Peter Maydell May 21, 2019, 12:25 p.m.
Create a bitops.rst which is just a container for the
kernel-doc comments in qemu/bitops.h.

This is mostly a test of the kernel-doc extension machinery.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

---
 docs/devel/bitops.rst | 8 ++++++++
 docs/devel/index.rst  | 1 +
 2 files changed, 9 insertions(+)
 create mode 100644 docs/devel/bitops.rst

-- 
2.20.1

Patch

diff --git a/docs/devel/bitops.rst b/docs/devel/bitops.rst
new file mode 100644
index 00000000000..6addaecf8d7
--- /dev/null
+++ b/docs/devel/bitops.rst
@@ -0,0 +1,8 @@ 
+==================
+Bitwise operations
+==================
+
+The header ``qemu/bitops.h`` provides utility functions for
+performing bitwise operations.
+
+.. kernel-doc:: include/qemu/bitops.h
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 2a4ddf40ad3..49cb212a8b4 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -21,3 +21,4 @@  Contents:
    testing
    decodetree
    secure-coding-practices
+   bitops