commit | e11caf5e8c1409b29120b1284e7b413cb2362ea5 | [log] [tgz] |
---|---|---|
author | Xin Li <delphij@google.com> | Mon Aug 14 16:37:52 2023 -0700 |
committer | Xin Li <delphij@google.com> | Mon Aug 14 16:37:52 2023 -0700 |
tree | efb478c7662c7dcd6832184fe8ffdeeae4382100 | |
parent | 6c6674f72e61afa3996824b432834de4d9a1bf36 [diff] | |
parent | 2aa0fa5666fee773ec83529ef35271524d6aa6bb [diff] |
Merge Android U (ab/10368041) Bug: 291102124 Merged-In: I772877822bd983a23d81661422bc379245a49ecc Change-Id: Iaf36d5d24472e8efae243256b72f1e4594e6730c
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.