aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorIan Spray <ian.spray@arm.com>2014-01-30 17:25:28 +0000
committerDan Handley <dan.handley@arm.com>2014-01-30 17:55:31 +0000
commit36eaaf37690c1019c99335e708361b5a613101db (patch)
tree39f8b4b782d50946ea257774af5f761039f54f9b /contributing.md
parent35fab8c979a2955bf031459ac630ad16012bcaa1 (diff)
downloadtrusted-firmware-a-36eaaf37690c1019c99335e708361b5a613101db.tar.gz
Allow style checking of tree and local changes
New phony Makefile targets have been added: * checkcodebase * checkpatch The checkcodebase target will run a Linux style compliance check over the entire codebase, and honours the V=1 Makefile verbose setting and so will show more information when this is enabled. If the local directory is a git checkout then the output of git ls-files is used to decide which files to test for compliance. If the local directory is not under git control then a 'best attempt' is made, but in this case it should be noted that it is possible for additional non-codebase files to be tested, so care should be taken when parsing the output. The checkpatch target will compare local changes against the git origin/master to allow issues with the last set of changes to be identified. To override the change comparision location, set the BASE_COMMIT variable to your desired git branch. Both targets rely on the Linux source tree script checkpatch.pl to do the syntax checking, and expects that the CHECKPATCH environment variable points to the location of this file. Notes on the usage of these targets have been added to the contributing.md and docs/user-guide.md text files. Change-Id: I6d73c97af578e24a34226d972afadab9d30f1d8d
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/contributing.md b/contributing.md
index b81766c6b7..01a90f8e7c 100644
--- a/contributing.md
+++ b/contributing.md
@@ -46,8 +46,11 @@ Making Changes
* Make commits of logical units. See these general [Git guidelines] for
contributing to a project.
-* Follow the [Linux coding style]; this style is re-used for the ARM Trusted
- Firmware project.
+* Follow the [Linux coding style]; this style is enforced for the ARM Trusted
+ Firmware project (style errors only, not warnings).
+ * Use the checkpatch.pl script provided with the Linux source tree. A
+ Makefile target is provided for convenience (see section 2 in the
+ [User Guide]).
* Keep the commits on topic. If you need to fix another bug or make another
enhancement, please create a separate [issue] and address it on a separate
topic branch.