commit | b8ea233fc4bfedb6f7b4c0ee6c4eb3167c473613 | [log] [tgz] |
---|---|---|
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Feb 02 00:28:27 2023 +0000 |
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Feb 02 00:28:27 2023 +0000 |
tree | 166094d4ece2cbfb7eb3adbcc2987f0ef0f7bfbf | |
parent | fd988c15302ded7109388dd80456ae282ccaef82 [diff] | |
parent | 833b585503ee9403f4358e05a4143770c5ed0464 [diff] |
Snap for 9552684 from 833b585503ee9403f4358e05a4143770c5ed0464 to tm-qpr3-release Change-Id: Ic78c20ce527870719b769f283de1d93ac70b936c
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.