commit | 3608b04142c53692d979efeb8f0e312e403ed402 | [log] [tgz] |
---|---|---|
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Wed Nov 01 17:18:29 2023 +0000 |
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Wed Nov 01 17:18:29 2023 +0000 |
tree | e497b2f785443b62b4b2d661995bb1d1322a8f0f | |
parent | 7f6bd2864a4f492d3f047646a2ddfc6f470c114b [diff] | |
parent | 9dc8c43529b23104501967724f6df75c63cab3d3 [diff] |
Snap for 11035591 from 9dc8c43529b23104501967724f6df75c63cab3d3 to androidx-media-release Change-Id: Icebddc626a33a8a42f22eb20708fdc9a825ad01a
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.