commit | 187c30493e0276b56fca31cbf73f0ab62c0b7fcb | [log] [tgz] |
---|---|---|
author | Scott Lobdell <slobdell@google.com> | Sun Apr 25 19:53:11 2021 +0000 |
committer | Scott Lobdell <slobdell@google.com> | Sun Apr 25 19:53:11 2021 +0000 |
tree | 36ad4012de2981dafd8fbf822f7cb716f3f4f09c | |
parent | fcf1b7c3e801d18b4fa7c5e9cdbce2909182e5e4 [diff] | |
parent | 9a1120705f2d9c38fd95fdfba7147c6a03e82e2a [diff] |
Merge SP1A.210425.001 Change-Id: I0b32d35a491a5200d1d68940fbf2f88fc3b13ccf
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.