aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2016-11-04 18:41:24 +0000
committerPeter Maydell <peter.maydell@linaro.org>2019-05-21 11:13:22 +0100
commit7d717d5648d1a21e3db7b20c66012623d55e5f63 (patch)
treedcc343e9a44cd5323029a9dcd1d869b54d713043
parentf2992a43269d545eae266827857b52b45c78dcc8 (diff)
downloadqemu-arm-7d717d5648d1a21e3db7b20c66012623d55e5f63.tar.gz
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>
-rw-r--r--docs/devel/bitops.rst8
-rw-r--r--docs/devel/index.rst1
2 files changed, 9 insertions, 0 deletions
diff --git a/docs/devel/bitops.rst b/docs/devel/bitops.rst
new file mode 100644
index 0000000000..6addaecf8d
--- /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 2a4ddf40ad..49cb212a8b 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -21,3 +21,4 @@ Contents:
testing
decodetree
secure-coding-practices
+ bitops