commit | e0d44a5df62c88d970a154307d6559f2fd3741aa | [log] [tgz] |
---|---|---|
author | Eric Arseneau <earseneau@google.com> | Mon Dec 06 14:37:01 2021 -0800 |
committer | Eric Arseneau <earseneau@google.com> | Mon Dec 06 14:37:01 2021 -0800 |
tree | 36ad4012de2981dafd8fbf822f7cb716f3f4f09c | |
parent | 187c30493e0276b56fca31cbf73f0ab62c0b7fcb [diff] | |
parent | 7d1ec47a6346259046de6baba0c87e711591d2f5 [diff] |
Merge mpr-2021-11-05 Change-Id: I8a05a1ffc9e84adf17348949f97a326eab0238fc
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.