commit | e645823b68ab8318f1bbf537daa48e9d488e680f | [log] [tgz] |
---|---|---|
author | Xin Li <delphij@google.com> | Thu Oct 05 15:43:34 2023 -0700 |
committer | Xin Li <delphij@google.com> | Thu Oct 05 15:43:34 2023 -0700 |
tree | 9e38a2839c0f3d1ba0e797afd77c573e4a7219ac | |
parent | 2511a1b15a266487d115262b3de72d34ed8cca8c [diff] | |
parent | 846680a897a1483ba299d6193e1ad04249628dfc [diff] |
Merge Android 14 Bug: 298295554 Merged-In: I1350ab5448f1d05b40a8a4a791e3e7227364c883 Change-Id: I535b65711cc68c21544457530bf2dac5398eaf5e
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.