diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2019-05-21 13:25:15 +0100 |
|---|---|---|
| committer | Paolo Bonzini <pbonzini@redhat.com> | 2019-12-17 19:36:57 +0100 |
| commit | f298bb45dc972c57c52c78c1d99df3bcdedf3a76 (patch) | |
| tree | cd4c593233156ad116a7baf20f5efa0e3cd3001f /docs | |
| parent | 7d41d764714a99df460fc275edfd33ac32a93349 (diff) | |
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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/devel/bitops.rst | 8 | ||||
| -rw-r--r-- | docs/devel/index.rst | 1 |
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 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 |