commit | 97b6c05cda1bfca4f684ff584c670c0716b0b332 | [log] [tgz] |
---|---|---|
author | Eric Arseneau <earseneau@google.com> | Thu Jan 13 18:52:38 2022 -0800 |
committer | Eric Arseneau <earseneau@google.com> | Thu Jan 13 18:52:38 2022 -0800 |
tree | c23cde41453e9697481fe3452b8d791da9bfba38 | |
parent | cc42fa7cb894b9bac5ed17ee1ccbb500fd367520 [diff] | |
parent | cee58e4d1df895dda038950d96db4ef31d8bb68d [diff] |
Merge r-mpr-2022-01-05 Change-Id: I9ccc940afd44cb1ef20956e6ff52acf361ae97d4
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.