Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/aml_wif_311811030
tagc1504c11346833f5365999595917eee13e7813b2
taggerThe Android Open Source Project <initial-contribution@android.com>Tue Aug 30 22:17:06 2022 -0700
objectddb2a7dac3ed7223dbcd2f43c4c771a7fbf71b0e 
aml_wif_311811030
commitddb2a7dac3ed7223dbcd2f43c4c771a7fbf71b0e[log] [tgz]
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Wed Mar 09 08:09:12 2022 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Wed Mar 09 08:09:12 2022 +0000
treeba998044a2b63dd8119c505e0870f764c35ede8e
parent4ee1e7b63a08d2d94b377df5cfcfccd39417ddd4 [diff]
parent0569da6981d542d02963d36d70f7c281c161f355 [diff]
Snap for 8278022 from 0569da6981d542d02963d36d70f7c281c161f355 to mainline-wifi-release

Change-Id: I7d6f3dd10a273a3fd9afa2ba643c2fec0a8c829f
tree: ba998044a2b63dd8119c505e0870f764c35ede8e
  1. gitlint/
  2. .gitignore
  3. android-style.xml
  4. checkstyle.jar
  5. checkstyle.py
  6. default-copyright-check.xml
  7. default-javadoc-checks.xml
  8. default-module-checks.xml
  9. default-treewalker-checks.xml
  10. LICENSE
  11. OWNERS
  12. PREUPLOAD.cfg
  13. README.md
  14. tests.py
README.md

Checkstyle

Checkstyle is used by developers to validate Java code style and formatting, and can be run as part of the pre-upload hooks.

Running it

It can be invoked in two ways.

  1. To check style of entire specific files: checkstyle.py -f FILE [FILE ...]
  2. To check style of the lines modified in the latest commit: checkstyle.py

Projects used

Checkstyle

A development tool to help programmers write Java code that adheres to a coding standard.

Git-Lint

Git-lint is a tool to run lint checks on only files changed in the latest commit.

  • URL: https://github.com/sk-/git-lint/
  • Version: 0.0.8
  • License: Apache 2.0
  • License File: gitlint/LICENSE
  • Local Modifications:
    • Downloaded gitlint/git.py and git/utils.py files individually.

Pre-upload linting

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.

Disabling Clang Format 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.