From: Peter Maydell Date: Mon, 14 Oct 2024 16:05:55 +0000 (+0100) Subject: docs/devel/lockcnt: Include kernel-doc API documentation X-Git-Tag: v9.2.0-rc0~47^2~8 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=0ae50e8e1e3799d22ca3431f0f238608dc2a4d36;p=thirdparty%2Fqemu.git docs/devel/lockcnt: Include kernel-doc API documentation Pull in the kernel-doc API documentation into the lockcnt docs. This requires us to fix one rST markup syntax error in the header file comments. Signed-off-by: Peter Maydell Message-id: 20240816132212.3602106-8-peter.maydell@linaro.org --- diff --git a/docs/devel/lockcnt.rst b/docs/devel/lockcnt.rst index 728594bcea3..8b43578f6c7 100644 --- a/docs/devel/lockcnt.rst +++ b/docs/devel/lockcnt.rst @@ -175,7 +175,7 @@ three instructions in the critical path, two assignments and a ``smp_wmb()``. ``QemuLockCnt`` API ------------------- -The ``QemuLockCnt`` API is described in ``include/qemu/lockcnt.h``. +.. kernel-doc:: include/qemu/lockcnt.h ``QemuLockCnt`` usage diff --git a/include/qemu/lockcnt.h b/include/qemu/lockcnt.h index 2c92ae17c9e..f4b62a3f701 100644 --- a/include/qemu/lockcnt.h +++ b/include/qemu/lockcnt.h @@ -51,7 +51,7 @@ void qemu_lockcnt_destroy(QemuLockCnt *lockcnt); * Because this function can wait on the mutex, it must not be * called while the lockcnt's mutex is held by the current thread. * For the same reason, qemu_lockcnt_inc can also contribute to - * AB-BA deadlocks. This is a sample deadlock scenario: + * AB-BA deadlocks. This is a sample deadlock scenario:: * * thread 1 thread 2 * -------------------------------------------------------