commit | af98913688ea2a0afddd387aeb33a49213b6785e | [log] [tgz] |
---|---|---|
author | Justin DeMartino <jjdemartino@google.com> | Mon Sep 21 13:24:07 2020 -0700 |
committer | Justin DeMartino <jjdemartino@google.com> | Mon Sep 21 13:24:07 2020 -0700 |
tree | d23c11abff6ec562d0b6bf17274f239af51c3b49 | |
parent | d1681bc5c9058e55dd55f0a7c9c16565060fc00a [diff] | |
parent | f0ba08ec9f1c811a8e32799d46611e8ea9dba69f [diff] |
Merge SP1A.200921.001 Change-Id: Ibaee8aa4328dfb7ebf868e0a37804290ee9794b9
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.