pw_sync: migrate docs to use list tables
Change-Id: I9290fa8a76e33ba3abf238b62f457e9c1cac5545
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/39912
Reviewed-by: Keir Mierle <keir@google.com>
Reviewed-by: Ewout van Bekkum <ewout@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Ewout van Bekkum <ewout@google.com>
diff --git a/pw_sync/docs.rst b/pw_sync/docs.rst
index 7a6b552..aec5900 100644
--- a/pw_sync/docs.rst
+++ b/pw_sync/docs.rst
@@ -117,24 +117,41 @@
**Precondition:** The mutex is held by this thread.
- +--------------------------------+----------+-------------+-------+
- | *Safe to use in context* | *Thread* | *Interrupt* | *NMI* |
- +--------------------------------+----------+-------------+-------+
- | ``Mutex::Mutex`` | ✔ | | |
- +--------------------------------+----------+-------------+-------+
- | ``Mutex::~Mutex`` | ✔ | | |
- +--------------------------------+----------+-------------+-------+
- | ``void Mutex::lock`` | ✔ | | |
- +--------------------------------+----------+-------------+-------+
- | ``bool Mutex::try_lock`` | ✔ | | |
- +--------------------------------+----------+-------------+-------+
- | ``bool Mutex::try_lock_for`` | ✔ | | |
- +--------------------------------+----------+-------------+-------+
- | ``bool Mutex::try_lock_until`` | ✔ | | |
- +--------------------------------+----------+-------------+-------+
- | ``void Mutex::unlock`` | ✔ | | |
- +--------------------------------+----------+-------------+-------+
+ .. list-table::
+
+ * - *Safe to use in context*
+ - *Thread*
+ - *Interrupt*
+ - *NMI*
+ * - ``Mutex::Mutex``
+ - ✔
+ -
+ -
+ * - ``Mutex::~Mutex``
+ - ✔
+ -
+ -
+ * - ``void Mutex::lock``
+ - ✔
+ -
+ -
+ * - ``bool Mutex::try_lock``
+ - ✔
+ -
+ -
+ * - ``bool Mutex::try_lock_for``
+ - ✔
+ -
+ -
+ * - ``bool Mutex::try_lock_until``
+ - ✔
+ -
+ -
+ * - ``void Mutex::unlock``
+ - ✔
+ -
+ -
Examples in C++
^^^^^^^^^^^^^^^
@@ -215,20 +232,32 @@
Invokes the ``Mutex::unlock`` member function on the given ``mutex``.
-+-------------------------------------+----------+-------------+-------+
-| *Safe to use in context* | *Thread* | *Interrupt* | *NMI* |
-+-------------------------------------+----------+-------------+-------+
-| ``void pw_sync_Mutex_Lock`` | ✔ | | |
-+-------------------------------------+----------+-------------+-------+
-| ``bool pw_sync_Mutex_TryLock`` | ✔ | | |
-+-------------------------------------+----------+-------------+-------+
-| ``bool pw_sync_Mutex_TryLockFor`` | ✔ | | |
-+-------------------------------------+----------+-------------+-------+
-| ``bool pw_sync_Mutex_TryLockUntil`` | ✔ | | |
-+-------------------------------------+----------+-------------+-------+
-| ``void pw_sync_Mutex_Unlock`` | ✔ | | |
-+-------------------------------------+----------+-------------+-------+
+.. list-table::
+ * - *Safe to use in context*
+ - *Thread*
+ - *Interrupt*
+ - *NMI*
+ * - ``void pw_sync_Mutex_Lock``
+ - ✔
+ -
+ -
+ * - ``bool pw_sync_Mutex_TryLock``
+ - ✔
+ -
+ -
+ * - ``bool pw_sync_Mutex_TryLockFor``
+ - ✔
+ -
+ -
+ * - ``bool pw_sync_Mutex_TryLockUntil``
+ - ✔
+ -
+ -
+ * - ``void pw_sync_Mutex_Unlock``
+ - ✔
+ -
+ -
Example in C
^^^^^^^^^^^^
@@ -322,20 +351,32 @@
**Precondition:** The spinlock is held by the caller.
- +-------------------------------------------+----------+-------------+-------+
- | *Safe to use in context* | *Thread* | *Interrupt* | *NMI* |
- +-------------------------------------------+----------+-------------+-------+
- | ``InterruptSpinLock::InterruptSpinLock`` | ✔ | ✔ | |
- +-------------------------------------------+----------+-------------+-------+
- | ``InterruptSpinLock::~InterruptSpinLock`` | ✔ | ✔ | |
- +-------------------------------------------+----------+-------------+-------+
- | ``void InterruptSpinLock::lock`` | ✔ | ✔ | |
- +-------------------------------------------+----------+-------------+-------+
- | ``bool InterruptSpinLock::try_lock`` | ✔ | ✔ | |
- +-------------------------------------------+----------+-------------+-------+
- | ``void InterruptSpinLock::unlock`` | ✔ | ✔ | |
- +-------------------------------------------+----------+-------------+-------+
+ .. list-table::
+ * - *Safe to use in context*
+ - *Thread*
+ - *Interrupt*
+ - *NMI*
+ * - ``InterruptSpinLock::InterruptSpinLock``
+ - ✔
+ - ✔
+ -
+ * - ``InterruptSpinLock::~InterruptSpinLock``
+ - ✔
+ - ✔
+ -
+ * - ``void InterruptSpinLock::lock``
+ - ✔
+ - ✔
+ -
+ * - ``bool InterruptSpinLock::try_lock``
+ - ✔
+ - ✔
+ -
+ * - ``void InterruptSpinLock::unlock``
+ - ✔
+ - ✔
+ -
Examples in C++
^^^^^^^^^^^^^^^
@@ -385,16 +426,24 @@
Invokes the ``InterruptSpinLock::unlock`` member function on the given ``interrupt_spin_lock``.
-+--------------------------------------------+----------+-------------+-------+
-| *Safe to use in context* | *Thread* | *Interrupt* | *NMI* |
-+--------------------------------------------+----------+-------------+-------+
-| ``void pw_sync_InterruptSpinLock_Lock`` | ✔ | ✔ | |
-+--------------------------------------------+----------+-------------+-------+
-| ``bool pw_sync_InterruptSpinLock_TryLock`` | ✔ | ✔ | |
-+--------------------------------------------+----------+-------------+-------+
-| ``void pw_sync_InterruptSpinLock_Unlock`` | ✔ | ✔ | |
-+--------------------------------------------+----------+-------------+-------+
+.. list-table::
+ * - *Safe to use in context*
+ - *Thread*
+ - *Interrupt*
+ - *NMI*
+ * - ``void pw_sync_InterruptSpinLock_Lock``
+ - ✔
+ - ✔
+ -
+ * - ``bool pw_sync_InterruptSpinLock_TryLock``
+ - ✔
+ - ✔
+ -
+ * - ``void pw_sync_InterruptSpinLock_Unlock``
+ - ✔
+ - ✔
+ -
Example in C
^^^^^^^^^^^^
