motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-30 13:31:52 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/devel/lockcnt: Include kernel-doc API documentation

Browse source 
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 <peter.maydell@linaro.org>
Message-id: 20240816132212.3602106-8-peter.maydell@linaro.org
This commit is contained in:
Peter Maydell 2024-10-14 17:05:55 +01:00
parent 51483f6c84
commit 0ae50e8e1e
2 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/devel/lockcnt.rst
View file

@ -175,7 +175,7 @@ three instructions in the critical path, two assignments and a ``smp_wmb()``.
``QemuLockCnt`` API ``QemuLockCnt`` API
------------------- -------------------
The ``QemuLockCnt`` API is described in ``include/qemu/lockcnt.h``. .. kernel-doc:: include/qemu/lockcnt.h
``QemuLockCnt`` usage ``QemuLockCnt`` usage

2
include/qemu/lockcnt.h
View file

@ -51,7 +51,7 @@ void qemu_lockcnt_destroy(QemuLockCnt *lockcnt);
* Because this function can wait on the mutex, it must not be * Because this function can wait on the mutex, it must not be
* called while the lockcnt's mutex is held by the current thread. * called while the lockcnt's mutex is held by the current thread.
* For the same reason, qemu_lockcnt_inc can also contribute to * 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 * thread 1 thread 2
* ------------------------------------------------------- * -------------------------------------------------------