Documentation: explain the difference between __bitwise and __bitwise__
authorSam Ravnborg <sam@ravnborg.org>
Fri, 10 Apr 2009 11:18:08 +0000 (13:18 +0200)
committerSam Ravnborg <sam@ravnborg.org>
Sat, 11 Apr 2009 06:18:11 +0000 (08:18 +0200)
Simply added explanation from Al Viro in the following mail:
http://lkml.indiana.edu/hypermail/linux/kernel/0802.2/3164.html

Cc: Al Viro <viro@ftp.linux.org.uk>
Cc: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Documentation/sparse.txt

index 42f43fa59f24c75c1f553dc5078f88b949302fd9..34c76a55bc0423182db5c73f76415503e2a7de1d 100644 (file)
@@ -42,6 +42,14 @@ sure that bitwise types don't get mixed up (little-endian vs big-endian
 vs cpu-endian vs whatever), and there the constant "0" really _is_
 special.
 
+__bitwise__ - to be used for relatively compact stuff (gfp_t, etc.) that
+is mostly warning-free and is supposed to stay that way.  Warnings will
+be generated without __CHECK_ENDIAN__.
+
+__bitwise - noisy stuff; in particular, __le*/__be* are that.  We really
+don't want to drown in noise unless we'd explicitly asked for it.
+
+
 Getting sparse
 ~~~~~~~~~~~~~~