commit | 5b129846c545ad22e7bd72f975902526c4864d9b | [log] [tgz] |
---|---|---|
author | Sorin Basca <sorinbasca@google.com> | Wed Sep 06 17:12:26 2023 +0000 |
committer | Sorin Basca <sorinbasca@google.com> | Mon Sep 11 09:19:12 2023 +0000 |
tree | f665d1b59fd67db591958d8bfdbaacb67db1adbd | |
parent | 3213ec11cc84aeb57bc9a1f701ad6edfa559c72f [diff] |
Allow missing javadoc for tests Change-Id: Ic7ee2f841dea15cdd6da1716a5bf26cbda697327 Fixes: 299262611 Test: repo upload
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.