commit | 869aed9a017380ef1517b15aff130e6c21e07eb1 | [log] [tgz] |
---|---|---|
author | Chris Craik <ccraik@google.com> | Fri Jan 26 12:17:37 2024 -0800 |
committer | Chris Craik <ccraik@google.com> | Fri Jan 26 12:18:39 2024 -0800 |
tree | fc32fdbe0e72b23ebf347d5ef57824c914503bf6 | |
parent | cbc1b8eda862ba707d62aeb235c8cf9d5664ca13 [diff] |
Clarify checkstyle error when java undefined Bug: 322525025 Test: Throws error correctly when java undefined on path # linux Change-Id: Iab72a5c4c2fdccb937ff80fab0f29289ad1707e9
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.