documentation: explain memory barriers
authorRandy Dunlap <[email protected]>
Thu, 16 Oct 2008 05:01:59 +0000 (22:01 -0700)
committerLinus Torvalds <[email protected]>
Thu, 16 Oct 2008 18:21:32 +0000 (11:21 -0700)
We want all uses of memory barriers to be explained in the source code.

Signed-off-by: Randy Dunlap <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
Signed-off-by: Linus Torvalds <[email protected]>
Documentation/SubmitChecklist

index 21f0795af20f1a6a3c34569f10ac05d72e8b75b4..ac5e0b2f1097c94333b9b6844bb708980786e028 100644 (file)
@@ -85,3 +85,6 @@ kernel patches.
 23: Tested after it has been merged into the -mm patchset to make sure
     that it still works with all of the other queued patches and various
     changes in the VM, VFS, and other subsystems.
+
+24: All memory barriers {e.g., barrier(), rmb(), wmb()} need a comment in the
+    source code that explains the logic of what they are doing and why.