summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-11-18 14:48:17 +0200
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-11-18 17:47:56 +0200
commitf2a1817275db8fb77acb5f2771b7577be8642194 (patch)
treec70c95636698b5d9840ac5da84e7c9bc652d56d7
parentd9a2a1f703273a28b001dee40fddd378bba7a1b6 (diff)
Documentation: coding-style: Document the git commit hooks
checkstyle.py is ignored too often. Document how to automate its usage through git commit hooks. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Umang Jain <umang.jain@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
-rw-r--r--Documentation/coding-style.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst
index 4e8d6988..053fdd99 100644
--- a/Documentation/coding-style.rst
+++ b/Documentation/coding-style.rst
@@ -418,4 +418,12 @@ diff that fixes the issues, on top of the corresponding commit. As the script is
in early development false positive are expected. The flagged issues should be
reviewed, but the diff doesn't need to be applied blindly.
+Execution of checkstyle.py can be automated through git commit hooks. Example
+of pre-commit and post-commit hooks are available in `utils/hooks/pre-commit`
+and `utils/hooks/post-commit`. You can install either hook by copying it to
+`.git/hooks/`. The post-commit hook is easier to start with as it will only flag
+potential issues after committing, while the pre-commit hook will abort the
+commit if issues are detected and requires usage of `git commit --no-verify` to
+ignore false positives.
+
Happy hacking, libcamera awaits your patches!