Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/android-12.1.0_r2
tag2b167c3e6b100841be7d404ee36b3077153e1ec7
taggerThe Android Open Source Project <initial-contribution@android.com>Mon Mar 21 12:52:31 2022 -0700
object3af193c478f295c72e1e34b097fa2d247c64ad2b 
Android 12.1.0 release 2
commit3af193c478f295c72e1e34b097fa2d247c64ad2b[log] [tgz]
authorandroid-build-team Robot <android-build-team-robot@google.com>Sat May 15 03:09:47 2021 +0000
committerandroid-build-team Robot <android-build-team-robot@google.com>Sat May 15 03:09:47 2021 +0000
tree36ad4012de2981dafd8fbf822f7cb716f3f4f09c
parent7f9376152bcb686c549c5471a4a532cc94c65c97 [diff]
parent146e72017e7bc965c9ab032a62a140b6f67eeb93 [diff]
Snap for 7362794 from 146e72017e7bc965c9ab032a62a140b6f67eeb93 to sc-v2-release

Change-Id: I392bbb7fe88ecd00e33bdb6fa43ec99c3e95ca4a
tree: 36ad4012de2981dafd8fbf822f7cb716f3f4f09c
  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.