redonkable
/
remarkable-linux
1
0
Fork 0
Code Releases Activity

[PATCH] docs: update sparse.txt with CHECK_ENDIAN 

Update the sparse documentation to omit the -Wbitwise flag example (as it
is now passed by default), and document the kernel defines to enable
endianness checking.

Signed-off-by: Bob Copeland <me@bobcopeland.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
wifi-calibration
Bob Copeland 2006-06-23 02:06:09 -07:00 committed by Linus Torvalds
parent eefe85ee35
commit e83319510b
1 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Documentation/sparse.txt
View File

@ -1,5 +1,6 @@
Copyright 2004 Linus Torvalds Copyright 2004 Linus Torvalds
Copyright 2004 Pavel Machek <pavel@suse.cz> Copyright 2004 Pavel Machek <pavel@suse.cz>
Copyright 2006 Bob Copeland <me@bobcopeland.com>
Using sparse for typechecking Using sparse for typechecking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -41,15 +42,8 @@ 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_ vs cpu-endian vs whatever), and there the constant "0" really _is_
special. special.
Use Getting sparse
~~~~~~~~~~~~~~
make C=[12] CF=-Wbitwise
or you don't get any checking at all.
Where to get sparse
~~~~~~~~~~~~~~~~~~~
With git, you can just get it from With git, you can just get it from
@ -57,7 +51,7 @@ With git, you can just get it from
and DaveJ has tar-balls at and DaveJ has tar-balls 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 Once you have it, just do
@ -65,8 +59,20 @@ Once you have it, just do
make make
make install make install
as your regular user, and it will install sparse in your ~/bin directory. as a 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 Using sparse
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).
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.