Pārlūkot izejas kodu

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>
Peter Maydell 6 gadi atpakaļ
vecāks
revīzija
f298bb45dc
2 mainītis faili ar 9 papildinājumiem un 0 dzēšanām
  1. 8 0
      docs/devel/bitops.rst
  2. 1 0
      docs/devel/index.rst

+ 8 - 0
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

+ 1 - 0
docs/devel/index.rst

@@ -23,3 +23,4 @@ Contents:
    secure-coding-practices
    tcg
    tcg-plugins
+   bitops