summaryrefslogtreecommitdiff
path: root/absl
diff options
context:
space:
mode:
authorGravatar Abseil Team <absl-team@google.com>2022-06-10 07:18:20 -0700
committerGravatar Copybara-Service <copybara-worker@google.com>2022-06-10 07:19:04 -0700
commit45eba9c16a513cda7fe53b44889c7300f158cf3d (patch)
treef58a017884fa43ef1c60fdce74c099e69ff69420 /absl
parentdb609075875320c32a197ae633302c50bead6e39 (diff)
Reformulate documentation of ABSL_LOCKS_EXCLUDED.
The intent of the macro is to say what locks cannot be held when calling the method, not making a promise that they will be acquired. PiperOrigin-RevId: 454158686 Change-Id: I71087460c3df27c7d6e0571156f19f525024f1de
Diffstat (limited to 'absl')
-rw-r--r--absl/base/thread_annotations.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/absl/base/thread_annotations.h b/absl/base/thread_annotations.h
index 9695f6de..bc8a6203 100644
--- a/absl/base/thread_annotations.h
+++ b/absl/base/thread_annotations.h
@@ -154,8 +154,8 @@
// ABSL_LOCKS_EXCLUDED()
//
-// Documents the locks acquired in the body of the function. These locks
-// cannot be held when calling this function (as Abseil's `Mutex` locks are
+// Documents the locks that cannot be held by callers of this function, as they
+// might be acquired by this function (Abseil's `Mutex` locks are
// non-reentrant).
#if ABSL_HAVE_ATTRIBUTE(locks_excluded)
#define ABSL_LOCKS_EXCLUDED(...) __attribute__((locks_excluded(__VA_ARGS__)))