commit | c532cab3976a7a0f701f406946c1b632388598a4 | [log] [tgz] |
---|---|---|
author | android-build-team Robot <android-build-team-robot@google.com> | Mon Sep 14 03:12:29 2020 +0000 |
committer | android-build-team Robot <android-build-team-robot@google.com> | Mon Sep 14 03:12:29 2020 +0000 |
tree | d23c11abff6ec562d0b6bf17274f239af51c3b49 | |
parent | 05972cfd796f747c85be0c175e690011624e2b97 [diff] | |
parent | 5e1d0453f3353dd551258f08f53b34bd4859e370 [diff] |
Snap for 6832314 from 5e1d0453f3353dd551258f08f53b34bd4859e370 to sc-d1-release Change-Id: Ie46b97dd88ad3ba056c289f30ca050d0c73fcd05
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.