X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=CodingStyle;fp=CodingStyle;h=2f24ee396f057ded30413ad71e80e46797d10be9;hb=bdd2719efb7483ea237698d8ca7c1459da01f368;hp=55b37a1cbc67361786864e844f9955460079d152;hpb=344e21d47ecfe342fc5c3c8f32020d7a43089301;p=sliver-openvswitch.git

diff --git a/CodingStyle b/CodingStyle
index 55b37a1cb..2f24ee396 100644
--- a/CodingStyle
+++ b/CodingStyle
@@ -298,6 +298,21 @@ the name of each enum.  For example:
     };
 
 
+THREAD SAFETY ANNOTATIONS
+
+  Use the macros in lib/compiler.h to annotate locking requirements.
+For example:
+
+    static struct ovs_mutex mutex = OVS_MUTEX_INITIALIZER;
+    static struct ovs_rwlock rwlock = OVS_RWLOCK_INITIALIZER;
+
+    void function_require_plain_mutex(void) OVS_REQUIRES(mutex);
+    void function_require_rwlock(void) OVS_REQ_RDLOCK(rwlock);
+
+  Pass lock objects, not their addresses, to the annotation macros.
+(Thus we have OVS_REQUIRES(mutex) above, not OVS_REQUIRES(&mutex).)
+
+
 SOURCE FILES
 
   Each source file should state its license in a comment at the very