commit | a0c8263eeee9f3b5bd0a5124d31a7ed47d72a2e3 | [log] [tgz] |
---|---|---|
author | Xin Li <delphij@google.com> | Fri Sep 11 00:39:36 2020 +0000 |
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | Fri Sep 11 00:39:36 2020 +0000 |
tree | d23c11abff6ec562d0b6bf17274f239af51c3b49 | |
parent | 2738924fcd4e7b353ed48b8efaebcbff7c197536 [diff] | |
parent | 9a3581ccecbb8918131aee21ed5553f2de9da043 [diff] |
[automerger skipped] Merge Android R am: 9a3581ccec -s ours am skip reason: Change-Id Ie91fd6a281f5e9ccb814a86ab1b18ea44564d427 with SHA-1 be2900434e is in history Original change: https://android-review.googlesource.com/c/platform/prebuilts/checkstyle/+/1421956 Change-Id: I5ff5b168d6ccdcacd01de0275f2b19fe561727e0
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.