Skip to content

idanpa/vscode-checkpatch

Repository files navigation

Checkpatch Lint

Visual Studio Code extension for using linux kernel checkpatch tool to lint code.

Installation

checkpatch.pl script should be either exposed through $PATH or pointed out by the checkpatch.checkpatchPath configuration.

sudo wget -O /usr/bin/checkpatch.pl "https://raw.githubusercontent.com/torvalds/linux/master/scripts/checkpatch.pl"
sudo wget -O /usr/bin/spelling.txt "https://raw.githubusercontent.com/torvalds/linux/master/scripts/spelling.txt"
sudo chmod 755 /usr/bin/checkpatch.pl

Windows

cmd as administrator:

curl -o %WINDIR%/System32/checkpatch.pl "https://raw.githubusercontent.com/torvalds/linux/master/scripts/checkpatch.pl"
curl -o %WINDIR%/System32/spelling.txt "https://raw.githubusercontent.com/torvalds/linux/master/scripts/spelling.txt"

On windows, a perl interpreter should also be installed - tested with ActivePerl Community Edition.
*.pl files should be configured to be opened by the interpreter by default (double click on any *.pl file and choose ActivePerl as the default program). GNU 'diff' executable should also be available (can be done by installing git-for-windows and adding it to PATH).

Commands

  • checkpatch.checkFile Check selected file (if the run mode is manual)
  • checkpatch.checkCommit Select specific commit to be tested
  • checkpatch.toggleAutoRun Toggle automatic checkpatch for the current workspace

Settings

  • checkpatch.checkpatchPath Path to the checkpatch.pl script
  • checkpatch.checkpatchArgs checkpatch arguments to use
  • checkpatch.run Control whether the linting is automatic on save or manually triggered using the checkpatch.checkFile command.
  • checkpatch.exclude Glob patterns for excluding files and folders from automatic checks.
  • checkpatch.diagnosticLevel Diagnostic level of checkpatch errors.

Releases

No releases published

Packages

No packages published