commit | 897b2f56333dfdf6086ce0321d3816c8797605e3 | [log] [tgz] |
---|---|---|
author | Matt Lee <matthewhlee@google.com> | Tue Dec 06 21:40:21 2022 -0800 |
committer | Matt Lee <matthewhlee@google.com> | Tue Dec 06 21:40:21 2022 -0800 |
tree | 166094d4ece2cbfb7eb3adbcc2987f0ef0f7bfbf | |
parent | b09530a883e9097c895daec14e21a7f8346479e1 [diff] | |
parent | 24d39158e43066ef00f1afe5fa7dfdbf94ba0b74 [diff] |
Merge t-qpr-2022-12 Change-Id: Ia080f8f61358ec579a948adcb05e3f40f5bd4caa
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.