commit | f37e3072f1325673dfc17978e5f9594706e55e9d | [log] [tgz] |
---|---|---|
author | Daniel Norman <danielnorman@google.com> | Mon Nov 30 11:41:58 2020 -0800 |
committer | Daniel Norman <danielnorman@google.com> | Mon Nov 30 11:41:58 2020 -0800 |
tree | d23c11abff6ec562d0b6bf17274f239af51c3b49 | |
parent | 9bba03e26518cf3412030d54ab481b8578d4ae7e [diff] | |
parent | 5fad53a020cd1c4c87f42509e528e0ed689c1eb9 [diff] |
Merge SP1A.201130.001 Change-Id: I140dd8fcb86aa43d9208adbd2d8089191c849369
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.