X-Git-Url: http://ftp.safe.ca/?a=blobdiff_plain;f=Documentation%2Fsparse.txt;h=34c76a55bc0423182db5c73f76415503e2a7de1d;hb=be3ad6b0b675fd1d6b48362ca30bdee75fbef6b4;hp=3f1c5464b1c9f1206dd497e891e1bd6e691d15fb;hpb=55032eacdb3acf54f5ba2e4dd9205db2c5c0bce2;p=safe%2Fjmp%2Flinux-2.6

diff --git a/Documentation/sparse.txt b/Documentation/sparse.txt
index 3f1c546..34c76a5 100644
--- a/Documentation/sparse.txt
+++ b/Documentation/sparse.txt
@@ -1,5 +1,6 @@
 Copyright 2004 Linus Torvalds
 Copyright 2004 Pavel Machek <pavel@suse.cz>
+Copyright 2006 Bob Copeland <me@bobcopeland.com>
 
 Using sparse for typechecking
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -41,23 +42,28 @@ 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.
 
-Use
+__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__.
 
-	make C=[12] CF=-Wbitwise
+__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.
 
-or you don't get any checking at all.
 
+Getting sparse
+~~~~~~~~~~~~~~
 
-Where to get sparse
-~~~~~~~~~~~~~~~~~~~
+You can get latest released versions from the Sparse homepage at
+http://www.kernel.org/pub/linux/kernel/people/josh/sparse/
 
-With git, you can just get it from
+Alternatively, you can get snapshots of the latest development version
+of sparse using git to clone..
 
-        rsync://rsync.kernel.org/pub/scm/devel/sparse/sparse.git
+        git://git.kernel.org/pub/scm/linux/kernel/git/josh/sparse.git
 
-and DaveJ has tar-balls at
+DaveJ has hourly generated tarballs of the git tree available at..
 
-	http://www.codemonkey.org.uk/projects/git-snapshots/sparse/
+        http://www.codemonkey.org.uk/projects/git-snapshots/sparse/
 
 
 Once you have it, just do
@@ -65,8 +71,20 @@ Once you have it, just do
         make
         make install
 
-as your regular user, and it will install sparse in your ~/bin directory.
-After that, doing a kernel make with "make C=1" will run sparse on all the
-C files that get recompiled, or with "make C=2" will run sparse on the
-files whether they need to be recompiled or not (ie the latter is fast way
-to check the whole tree if you have already built it).
+as a regular user, and it will install sparse in your ~/bin directory.
+
+Using sparse
+~~~~~~~~~~~~
+
+Do a kernel make with "make C=1" to run sparse on all the C files that get
+recompiled, or use "make C=2" to run sparse on the files whether they need to
+be recompiled or not.  The latter is a fast way to check the whole tree if you
+have already built it.
+
+The optional make variable CF can be used to pass arguments to sparse.  The
+build system passes -Wbitwise to sparse automatically.  To perform endianness
+checks, you may define __CHECK_ENDIAN__:
+
+        make C=2 CF="-D__CHECK_ENDIAN__"
+
+These checks are disabled by default as they generate a host of warnings.