aboutsummaryrefslogtreecommitdiff
path: root/include/odp/api/spinlock.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/odp/api/spinlock.h')
-rw-r--r--include/odp/api/spinlock.h11
1 files changed, 8 insertions, 3 deletions
diff --git a/include/odp/api/spinlock.h b/include/odp/api/spinlock.h
index 9a5a9290a..154d0258a 100644
--- a/include/odp/api/spinlock.h
+++ b/include/odp/api/spinlock.h
@@ -18,9 +18,14 @@
extern "C" {
#endif
-/** @addtogroup odp_synchronizers
- * Operations on spin locks.
- * @{
+/**
+ * @addtogroup odp_locks
+ * @details
+ * <b> Spin lock (odp_spinlock_t) </b>
+ *
+ * Spinlock simply re-tries to acquire the lock as long as takes to succeed.
+ * Spinlock is not fair since some threads may succeed more often than others.
+ * @{
*/
/**