commit | d2a32ccc8d83c0bc2e28732a9d09569a2bb0b89f | [log] [tgz] |
---|---|---|
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Tue Sep 05 19:03:23 2023 +0000 |
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Tue Sep 05 19:03:23 2023 +0000 |
tree | ca01d6fcdeb9c4b872f9dfc4481a16087f613642 | |
parent | 4a4bf2e974877bc8d12114106d6a9f7eb9c481e2 [diff] | |
parent | 3213ec11cc84aeb57bc9a1f701ad6edfa559c72f [diff] |
Snap for 10763169 from 3213ec11cc84aeb57bc9a1f701ad6edfa559c72f to androidx-room-release Change-Id: Id1834ad376fc2a49985f8ba918950da529cb78a0
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.