atomic_ops.txt: mention local_t
authorGrant Grundler <grundler@parisc-linux.org>
Wed, 17 Oct 2007 06:29:28 +0000 (23:29 -0700)
committerLinus Torvalds <torvalds@woody.linux-foundation.org>
Wed, 17 Oct 2007 15:42:56 +0000 (08:42 -0700)
local_t is a variant of atomic_t and has related ops to match.
Add reference for local_t documentation to atomic_ops.txt.

Signed-off-by: Grant Grundler <grundler@parisc-linux.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Documentation/atomic_ops.txt

index 05851e9982edfefbab5ead5b774ab976926a12e4..938f99957052461c552d4b9a4bb0c5d4042bbfaa 100644 (file)
@@ -14,6 +14,10 @@ suffice:
 
        typedef struct { volatile int counter; } atomic_t;
 
+local_t is very similar to atomic_t. If the counter is per CPU and only
+updated by one CPU, local_t is probably more appropriate. Please see
+Documentation/local_ops.txt for the semantics of local_t.
+
        The first operations to implement for atomic_t's are the
 initializers and plain reads.