https://github.com/stsquad/checkpatch-mode

A simple mode for running checkpatch scripts.
https://github.com/stsquad/checkpatch-mode

emacs-add-on emacs-lisp emacs-mode

Last synced: about 2 months ago
JSON representation

A simple mode for running checkpatch scripts.

• Host: GitHub
• URL: https://github.com/stsquad/checkpatch-mode
• Owner: stsquad
• Created: 2017-02-09T14:57:45.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-16T13:11:14.000Z (5 months ago)
• Last Synced: 2024-08-16T14:35:49.745Z (5 months ago)
• Topics: emacs-add-on, emacs-lisp, emacs-mode
• Language: Emacs Lisp
• Size: 24.4 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

README

        
* Introduction

This is a simple minor-mode for running checkpatch scripts.

A checkpatch script is a script that will scan a patch or file and

check the code meets a number of criteria. This sort of automatic code

review is encouraged as it means people will spend less time

correcting stylistic mistakes and can concentrate on the core code

changes.

* User entry functions

Currently the user facing functions are:

  - checkpatch-run-against-file

  - checkpatch-run-against-patch-file

  - checkpatch-run-from-magit

The last function it for calling from magit and will only work if

(magit-commit-at-point) finds a commit (e.g. point is at a log entry).

* Implementation Details

This minor mode is a derived from compilation-mode. The

checkpatch-mode-regex is currently tuned to the output from the Linux

kernel checkpatch.

* Future work

** TODO Make checkpatch-find-script-or-prompt smarter

Currently we set the script path as a local variable when we are first

called however we could be smarter looking at common locations.