commit | 0552dbab759ffab42e46aa5d48519d5df5eba8d5 | [log] [tgz] |
---|---|---|
author | android-build-team Robot <android-build-team-robot@google.com> | Wed Oct 07 21:19:02 2020 +0000 |
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | Wed Oct 07 21:19:02 2020 +0000 |
tree | c23cde41453e9697481fe3452b8d791da9bfba38 | |
parent | 5eec6cd1c1d127d3078c77ac92aebfcf632b30f2 [diff] | |
parent | 9e74305498d40b2d52aa0def98244916e48d8ebe [diff] |
Snap for 6670641 from c05b54f806a0283a022284fdf571bba8884b742f to rvc-qpr1-release am: 9e74305498 Original change: https://googleplex-android-review.googlesource.com/c/platform/prebuilts/checkstyle/+/12131895 Change-Id: I8994de03bb8c9f6ef7144e74b1cecbe81d4cf772
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.