commit | f2d16b068a7bfe8137dcc0619f5751bc3a10e9ec | [log] [tgz] |
---|---|---|
author | Sorin Basca <sorinbasca@google.com> | Mon Sep 11 18:10:06 2023 +0000 |
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | Mon Sep 11 18:10:06 2023 +0000 |
tree | 93cf787563d90453252d2f70504811d718ddc948 | |
parent | 07508cbd28a398c92956868d9f4c27bffc26b37c [diff] | |
parent | 155d626b1d07faf4b79c0b1ef9b9eed9643785fe [diff] |
Allow missing javadoc for tests am: 5b129846c5 am: 606dc50520 am: 155d626b1d Original change: https://android-review.googlesource.com/c/platform/prebuilts/checkstyle/+/2743654 Change-Id: Ic6155fa392f4a10b7aa4bfdbbb66cf5bb3075436 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
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.