diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/sparse.txt | 36 |
1 files changed, 21 insertions, 15 deletions
diff --git a/Documentation/sparse.txt b/Documentation/sparse.txt index 3f1c5464b1c9..5a311c38dd1a 100644 --- a/Documentation/sparse.txt +++ b/Documentation/sparse.txt | |||
| @@ -1,5 +1,6 @@ | |||
| 1 | Copyright 2004 Linus Torvalds | 1 | Copyright 2004 Linus Torvalds |
| 2 | Copyright 2004 Pavel Machek <pavel@suse.cz> | 2 | Copyright 2004 Pavel Machek <pavel@suse.cz> |
| 3 | Copyright 2006 Bob Copeland <me@bobcopeland.com> | ||
| 3 | 4 | ||
| 4 | Using sparse for typechecking | 5 | Using sparse for typechecking |
| 5 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| @@ -41,15 +42,8 @@ sure that bitwise types don't get mixed up (little-endian vs big-endian | |||
| 41 | vs cpu-endian vs whatever), and there the constant "0" really _is_ | 42 | vs cpu-endian vs whatever), and there the constant "0" really _is_ |
| 42 | special. | 43 | special. |
| 43 | 44 | ||
| 44 | Use | 45 | Getting sparse |
| 45 | 46 | ~~~~~~~~~~~~~~ | |
| 46 | make C=[12] CF=-Wbitwise | ||
| 47 | |||
| 48 | or you don't get any checking at all. | ||
| 49 | |||
| 50 | |||
| 51 | Where to get sparse | ||
| 52 | ~~~~~~~~~~~~~~~~~~~ | ||
| 53 | 47 | ||
| 54 | With git, you can just get it from | 48 | With git, you can just get it from |
| 55 | 49 | ||
| @@ -57,7 +51,7 @@ With git, you can just get it from | |||
| 57 | 51 | ||
| 58 | and DaveJ has tar-balls at | 52 | and DaveJ has tar-balls at |
| 59 | 53 | ||
| 60 | http://www.codemonkey.org.uk/projects/git-snapshots/sparse/ | 54 | http://www.codemonkey.org.uk/projects/git-snapshots/sparse/ |
| 61 | 55 | ||
| 62 | 56 | ||
| 63 | Once you have it, just do | 57 | Once you have it, just do |
| @@ -65,8 +59,20 @@ Once you have it, just do | |||
| 65 | make | 59 | make |
| 66 | make install | 60 | make install |
| 67 | 61 | ||
| 68 | as your regular user, and it will install sparse in your ~/bin directory. | 62 | as a regular user, and it will install sparse in your ~/bin directory. |
| 69 | After that, doing a kernel make with "make C=1" will run sparse on all the | 63 | |
| 70 | C files that get recompiled, or with "make C=2" will run sparse on the | 64 | Using sparse |
| 71 | files whether they need to be recompiled or not (ie the latter is fast way | 65 | ~~~~~~~~~~~~ |
| 72 | to check the whole tree if you have already built it). | 66 | |
| 67 | Do a kernel make with "make C=1" to run sparse on all the C files that get | ||
| 68 | recompiled, or use "make C=2" to run sparse on the files whether they need to | ||
| 69 | be recompiled or not. The latter is a fast way to check the whole tree if you | ||
| 70 | have already built it. | ||
| 71 | |||
| 72 | The optional make variable CF can be used to pass arguments to sparse. The | ||
| 73 | build system passes -Wbitwise to sparse automatically. To perform endianness | ||
| 74 | checks, you may define __CHECK_ENDIAN__: | ||
| 75 | |||
| 76 | make C=2 CF="-D__CHECK_ENDIAN__" | ||
| 77 | |||
| 78 | These checks are disabled by default as they generate a host of warnings. | ||