This linter plugin for SublimeLinter provides an interface to linux kernel 'checkpatch.pl' tool for C linting.
- Total 1K
- Win 710
- Mac 453
- Linux 279
|Jun 1||May 31||May 30||May 29||May 28||May 27||May 26||May 25||May 24||May 23||May 22||May 21||May 20||May 19||May 18||May 17||May 16||May 15||May 14||May 13||May 12||May 11||May 10||May 9||May 8||May 7||May 6||May 5||May 4||May 3||May 2||May 1||Apr 30||Apr 29||Apr 28||Apr 27||Apr 26||Apr 25||Apr 24||Apr 23||Apr 22||Apr 21||Apr 20||Apr 19||Apr 18|
This linter plugin for SublimeLinter provides an interface to linux kernel checkpatch.pl tool. It will be used with files that have the “C” syntax (it won't work on “C++“ syntax).
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
checkpatch.pl is installed on your system. To install
checkpatch.pl, do the following:
- Verify that perl is installed on your system by typing the following in a terminal :
- Get the source of the linux kernel. You can for instance type the following in a terminal:
git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
- Put checkpatch.pl in your path. On linux, you can for instance create a symbolic link by typing something like the following in a terminal:
sudo ln -s /path/to/kernel/source/tree/scripts/checkpatch.pl /usr/local/bin
Note: This plugin requires
checkpatch.pl 0.32 or later.
In order for
checkpatch to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.
Once you have installed and configured
checkpatch, you can proceed to install the SublimeLinter-contrib-checkpatch plugin if it is not yet installed.
Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
To install via Package Control, do the following:
Within Sublime Text, bring up the Command Palette and type
install. Among the commands you should see
Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.
When the plugin list appears, type
checkpatch. Among the entries you should see
SublimeLinter-contrib-checkpatch. If that entry is not highlighted, use the keyboard or mouse to select it.
For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.
In addition to the standard SublimeLinter settings, SublimeLinter-contrib-checkpatch provides its own settings.
|root||PATH to the kernel tree root.|
You must set this path to point to a valid kernel source tree (or you can add the “–no-tree“ in the
checkpatch args setting, but in this case checkpatch won't be able to report all possible error/warning).
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- Be patient. ;-)
Please note that modifications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbreviations unless they are very well known.
Thank you for helping out!