docs: Create bitops.rst as example of kernel-docs

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>
Message-Id: <20190521122519.12573-7-peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

diff --git a/docs/devel/bitops.rst b/docs/devel/bitops.rst
new file mode 100644 (file)
index 0000000..6addaec
--- /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 c86a3cdff2fcc699ba04be206e282bd7c0dccab4..ac862152dcb330866f7869460ded072476b33891 100644 (file)
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -23,3 +23,4 @@ Contents:
    secure-coding-practices
    tcg
    tcg-plugins
+   bitops