Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/android-11.0.0_r5
tag4668bfd10d5b2623cf574dc24490aa0974bac9c3
taggerThe Android Open Source Project <initial-contribution@android.com>Mon Oct 05 14:59:23 2020 -0700
object5eec6cd1c1d127d3078c77ac92aebfcf632b30f2 
Android 11.0.0 Release 5 (RP1A.201005.006)
commit5eec6cd1c1d127d3078c77ac92aebfcf632b30f2[log] [tgz]
authorandroid-build-team Robot <android-build-team-robot@google.com>Sat Jul 11 01:11:57 2020 +0000
committerandroid-build-team Robot <android-build-team-robot@google.com>Sat Jul 11 01:11:57 2020 +0000
treec23cde41453e9697481fe3452b8d791da9bfba38
parent5f986d6e3094f3530f37495b82f80d527ff6ae4d [diff]
parentadef809ab8b15022a6c7256e472a88c9901dc64d [diff]
Snap for 6671561 from adef809ab8b15022a6c7256e472a88c9901dc64d to rvc-release

Change-Id: I13b0b5d890c56e078ec0d27e66c7dadb75d32788
tree: c23cde41453e9697481fe3452b8d791da9bfba38
  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.