From: Martin Quinson <martin.quinson@ens-rennes.fr>
Date: Tue, 24 Oct 2023 23:04:05 +0000 (+0200)
Subject: Document our mutexes
X-Git-Tag: v3.35~89^2~57
X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/5b6b4fb3d4d40df76d31115c0a91d3c8e603202b

Document our mutexes
---

diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp
index 7791cd7e23..2e7a1012b1 100644
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -12,6 +12,8 @@
 namespace simgrid::s4u {
 
 /** @brief A classical mutex, but blocking in the simulation world.
+ *
+ * S4U mutexes are not recursive. If an actor tries to lock the same object twice, it deadlocks with itself.
  *
  * @beginrst
  * It is strictly impossible to use a real mutex, such as