commit | bcd97fe062ff352b039c8b653cf2629f248fdfa1 | [log] [tgz] |
---|---|---|
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Wed Apr 06 20:40:31 2022 +0000 |
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Wed Apr 06 20:40:31 2022 +0000 |
tree | 166094d4ece2cbfb7eb3adbcc2987f0ef0f7bfbf | |
parent | 1d74a2fb270d001b84f669b42b8704e325a5532d [diff] | |
parent | fd988c15302ded7109388dd80456ae282ccaef82 [diff] |
Snap for 8414339 from fd988c15302ded7109388dd80456ae282ccaef82 to tm-qpr1-release Change-Id: Ibe04cf1dbd33fab7be4f98eb32fd1a5ddfc90a7e
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.