[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 6/8] docs: Create bitops.rst as example of kernel-docs
From: |
Paolo Bonzini |
Subject: |
[PATCH 6/8] docs: Create bitops.rst as example of kernel-docs |
Date: |
Fri, 29 Nov 2019 15:02:15 +0100 |
From: Peter Maydell <address@hidden>
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 <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
---
docs/devel/bitops.rst | 8 ++++++++
docs/devel/index.rst | 1 +
2 files changed, 9 insertions(+)
create mode 100644 docs/devel/bitops.rst
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 c86a3cdff2..ac862152dc 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -23,3 +23,4 @@ Contents:
secure-coding-practices
tcg
tcg-plugins
+ bitops
--
2.21.0
- [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build, Paolo Bonzini, 2019/11/29
- [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 <=
- [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