commit | cc42fa7cb894b9bac5ed17ee1ccbb500fd367520 | [log] [tgz] |
---|---|---|
author | Eric Arseneau <earseneau@google.com> | Thu Dec 10 15:41:42 2020 -0800 |
committer | Eric Arseneau <earseneau@google.com> | Thu Dec 10 15:41:42 2020 -0800 |
tree | c23cde41453e9697481fe3452b8d791da9bfba38 | |
parent | 4cdc6738c488f3e81f3d49f7b7ae4e04dc4842f9 [diff] | |
parent | 9e74305498d40b2d52aa0def98244916e48d8ebe [diff] |
Merge spl-2020-12-05 Change-Id: Ic71239428f9ad04f9e63a4efc436bd1b9f2021f8
Checkstyle is used by developers to validate Java code style and formatting, and can be run as part of the pre-upload hooks.
It can be invoked in two ways.
checkstyle.py -f FILE [FILE ...]
checkstyle.py
A development tool to help programmers write Java code that adheres to a coding standard.
Git-lint is a tool to run lint checks on only files changed in the latest commit.
To run checkstyle as part of the pre-upload hooks, add the following line to your PREUPLOAD.cfg
:
checkstyle_hook = ${REPO_ROOT}/prebuilts/checkstyle/checkstyle.py --sha ${PREUPLOAD_COMMIT}
Note that checkstyle does not always agree with clang-format, and so it's best to only have one enabled for Java.
In .clang-format
add the following to disable format checking and correcting for Java:
--- Language: Java DisableFormat: true SortIncludes: false ---
In some versions of clang-format, DisableFormat
doesn't stop the sorting of includes. So to fully disable clang-format from doing anything for Java files, both options are needed.