commit | fcf1b7c3e801d18b4fa7c5e9cdbce2909182e5e4 | [log] [tgz] |
---|---|---|
author | Scott Lobdell <slobdell@google.com> | Tue Feb 23 11:55:17 2021 -0800 |
committer | Scott Lobdell <slobdell@google.com> | Tue Feb 23 11:55:17 2021 -0800 |
tree | c78d9fbd5d784dd9d3a79c9cfd1bd0c10b33dbb8 | |
parent | 9a88989b128da13c7d0be10d1b688a094d10b95c [diff] | |
parent | e05b9c6d3fdcb57a3d8f72027857a35fa52251c1 [diff] |
Merge SP1A.210222.001 Change-Id: I6dd1b334ccfcb8d07cc80aede19b73f16e0788b0
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.