checkpatch.pl - Coding Style, Spell Check

-
checkpatch.pl is perl script present in scripts folder of the Linux Source code. It is used by the developers to verify the patches follows Linux Coding Style or not before upstreaming them.

E.g. $ ./scripts/checkpatch.pl <patchfile.patch>

To see what all options are supported by checkpatch, run "checkpatch.pl --help"

How to use checkpatch.pl to verify coding style of our own C Source files?

 $ ./checkpatch.pl --no-tree --file mychardriver.c

--no-tree option allows to run without a kernel tree
--file option tells checkpatch to treat this as a file instead of patch.

To list all the various messages it supports, run

$ ./checkpatch.pl --list-types


You can look more info about each message in checkpatch.pl file



You can use checkpatch.pl to check for spellings and typos, for that you need to have codespell package installed, if you dont' have install it with the following command:

sudo apt-get install codespell

And enable codespell parameter: $ ./checkpatch.pl --codespell --no-tree --file mychardriver.c

./checkpatch.pl also have experimental feature to auto correct some errors, using "--fix" or "--fix-inplace" options

Comments

Post a Comment

Popular posts from this blog

bb.utils.contains yocto

-
Image
bb.utils.contains  is most commonly used function in Yocto. grep in poky directory returned with 696 count. $ grep -nr 'bb.utils.contains' poky/ | wc -l 696 It's definition is present in 'poky/bitbake/lib/bb/utils.py' file This function returns third argument if the second argument is subset of the first argument else returns fourth argument Let's take an example to understand this. You can see from the above screenshot, when the second argument is a subset of first argument, "present" was returned, else "notpresent" was returned We can also use bb.utils.contains inside if loop. This we can use inside a recipe. if ${@bb.utils.contains('SOMEFLAG','NEWVALUE3','true','false',d)}; then     FOO = 'HELLO' fi
Read more

make config vs oldconfig vs defconfig vs menuconfig vs savedefconfig

-
Image
Building the Linux Kernel is a two-step process: Configuring the Kernel options Building the Kernel with those options. There are many methods available for configuring the kernel. make config: Text-based Configuration.  Options are prompted one after another. All options need to be answered Access to former options is not possible make menuconfig: Menu-driven user interface Allows to navigate forwards and backward directly between features Allows to load and save files with filenames different from ".config" Provides search feature It uses ncurses library for GUI. If the ncurses library is not installed, make menuconfig option fails. To install ncurses library on Ubuntu: sudo apt-get install libncurses5-dev make defconfig: Creates a ".config" file with default options from the ARCH supplied defconfig Configurations are generally stored in the directory: arch/$(ARCH)/configs $ ls arch/x86/configs/ i386_defconfi
Read more

PR, PN and PV Variable in Yocto

-
PN : Represents the name of the recipe. The name is usually extracted from the recipe file name. PR:  Represents the revision of the recipe. Default value for this revision is "r0". Subsequent revisions of the recipe conventionally will have "r1", "r2" and so on. PV:  Represents the version of the recipe. Normally extracted from the recipe file name. For example: ffmpeg_3.4.2.bb recipe. ${PN} : ffmpeg ${PV} : 3.4.2
Read more