commit | 153a9a100eae7fdba5989ce39a5dd1782075517f | [log] [tgz] |
---|---|---|
author | Hayden Gomes <haydengomes@google.com> | Fri Aug 16 09:37:21 2019 -0700 |
committer | Hayden Gomes <haydengomes@google.com> | Fri Aug 16 13:21:42 2019 -0700 |
tree | da7f6725407d4ece9fd372ce4ce8406d5dade979 | |
parent | cca7ecaa5d8c398f41bfec7938cc6a526803579b [diff] |
Adding Pre-upload instructions to checkstyle README Bug: 139472606 Test: Applied suggested changes to a PREUPLOAD.cfg Change-Id: Iab2583e87a7f2d110493e94e586f51724e708b8b
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.