mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-23 04:34:11 +08:00
1c7bafe720
Clarify the use of "make C=" in the top-level Makefile, and fix a typo in the Documentation file. Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
79 lines
2.5 KiB
Plaintext
79 lines
2.5 KiB
Plaintext
Copyright 2004 Linus Torvalds
|
|
Copyright 2004 Pavel Machek <pavel@suse.cz>
|
|
Copyright 2006 Bob Copeland <me@bobcopeland.com>
|
|
|
|
Using sparse for typechecking
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
"__bitwise" is a type attribute, so you have to do something like this:
|
|
|
|
typedef int __bitwise pm_request_t;
|
|
|
|
enum pm_request {
|
|
PM_SUSPEND = (__force pm_request_t) 1,
|
|
PM_RESUME = (__force pm_request_t) 2
|
|
};
|
|
|
|
which makes PM_SUSPEND and PM_RESUME "bitwise" integers (the "__force" is
|
|
there because sparse will complain about casting to/from a bitwise type,
|
|
but in this case we really _do_ want to force the conversion). And because
|
|
the enum values are all the same type, now "enum pm_request" will be that
|
|
type too.
|
|
|
|
And with gcc, all the __bitwise/__force stuff goes away, and it all ends
|
|
up looking just like integers to gcc.
|
|
|
|
Quite frankly, you don't need the enum there. The above all really just
|
|
boils down to one special "int __bitwise" type.
|
|
|
|
So the simpler way is to just do
|
|
|
|
typedef int __bitwise pm_request_t;
|
|
|
|
#define PM_SUSPEND ((__force pm_request_t) 1)
|
|
#define PM_RESUME ((__force pm_request_t) 2)
|
|
|
|
and you now have all the infrastructure needed for strict typechecking.
|
|
|
|
One small note: the constant integer "0" is special. You can use a
|
|
constant zero as a bitwise integer type without sparse ever complaining.
|
|
This is because "bitwise" (as the name implies) was designed for making
|
|
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.
|
|
|
|
Getting sparse
|
|
~~~~~~~~~~~~~~
|
|
|
|
With git, you can just get it from
|
|
|
|
rsync://rsync.kernel.org/pub/scm/devel/sparse/sparse.git
|
|
|
|
and DaveJ has tar-balls at
|
|
|
|
http://www.codemonkey.org.uk/projects/git-snapshots/sparse/
|
|
|
|
|
|
Once you have it, just do
|
|
|
|
make
|
|
make install
|
|
|
|
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 CHECKFLAGS 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 CHECKFLAGS="-D__CHECK_ENDIAN__"
|
|
|
|
These checks are disabled by default as they generate a host of warnings.
|