diff options
| author | Aaron Conole <aconole@redhat.com> | 2016-03-31 10:45:35 -0400 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-03-31 08:29:14 -0700 |
| commit | c599d5ccf3166b9af34e6941670d75b07a56f74f (patch) | |
| tree | 00c80e6e6ac9183b5cce481e69d5d1ae20fc890e /CONTRIBUTING.md | |
| parent | fdb876e405c797d789a38f06ad90f8402155f7b6 (diff) | |
| download | openvswitch-c599d5ccf3166b9af34e6941670d75b07a56f74f.tar.gz | |
checkpatch.py: A simple script for finding patch issues
Most projects have a checkpatch facility, which can be used as a pre-commit
sanity check. This introduces such a mechanism to the Open vSwitch project
to catch some of the more silly formatting mistakes which can occur. It is
not meant to replace good code review practices, but it can help eliminate
the silly code review issues which get added.
Suggested-by: Mauricio Vásquez <mauricio.vasquezbernal@studenti.polito.it>
Signed-off-by: Aaron Conole <aconole@redhat.com>
[blp@ovn.org adjusted long line threshold and treatment of terminal]
Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fcebba3d..68442d248 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -358,6 +358,12 @@ Please follow the style used in the code that you are modifying. The [CodingStyle.md] file describes the coding style used in most of Open vSwitch. Use Linux kernel coding style for Linux kernel code. +If your code is non-datapath code, you may use the +`utilities/checkpatch.py` utility as a quick check for certain commonly +occuring mistakes (improper leading/trailing whitespace, missing signoffs, +some improper formatted patch files). For linux datapath code, it is +a good idea to use the linux script `checkpatch.pl`. + Example ------- |