commit | a9a985d8d9153930de92ece929fe74a836c88015 | [log] [tgz] |
---|---|---|
author | android-build-team Robot <android-build-team-robot@google.com> | Fri Jun 04 03:09:15 2021 +0000 |
committer | android-build-team Robot <android-build-team-robot@google.com> | Fri Jun 04 03:09:15 2021 +0000 |
tree | 36ad4012de2981dafd8fbf822f7cb716f3f4f09c | |
parent | 9836f0be7cef56a4039305f0e477e15d504d4286 [diff] | |
parent | c3302b0218c74f8cb730f00b429ea21e79086bff [diff] |
Snap for 7422738 from c3302b0218c74f8cb730f00b429ea21e79086bff to tm-release Change-Id: Ie5b32027e6f127290d810ce181913febe8863cfe
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.