[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 7/7] docs/devel/lockcnt: Include kernel-doc API documentation
|
From: |
Peter Maydell |
|
Subject: |
[PATCH 7/7] docs/devel/lockcnt: Include kernel-doc API documentation |
|
Date: |
Fri, 16 Aug 2024 14:22:12 +0100 |
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>
---
docs/devel/lockcnt.rst | 2 +-
include/qemu/lockcnt.h | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
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
* -------------------------------------------------------
--
2.34.1
- [PATCH for-9.2 0/7] docs/devel: Convert txt files to rST, Peter Maydell, 2024/08/16
- [PATCH 2/7] docs/devel/blkverify: Convert to rST format, Peter Maydell, 2024/08/16
- [PATCH 1/7] docs/devel/blkdebug: Convert to rST format, Peter Maydell, 2024/08/16
- [PATCH 3/7] docs/devel/lockcnt: Convert to rST format, Peter Maydell, 2024/08/16
- [PATCH 6/7] include: Move QemuLockCnt APIs to their own header, Peter Maydell, 2024/08/16
- [PATCH 4/7] docs/devel/multiple-iothreads: Convert to rST format, Peter Maydell, 2024/08/16
- [PATCH 7/7] docs/devel/lockcnt: Include kernel-doc API documentation,
Peter Maydell <=
- [PATCH 5/7] docs/devel/rcu: Convert to rST format, Peter Maydell, 2024/08/16