Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/android-14.0.0_r12
tag3e7e59b1dffee9d95a49702433bfbfd784f9b7f1
taggerThe Android Open Source Project <initial-contribution@android.com>Mon Nov 06 20:44:57 2023 -0800
object2d4e4b4e93ec0a68f569f9369cc884bf4db6087e 
Android 14.0.0 release 12
commit2d4e4b4e93ec0a68f569f9369cc884bf4db6087e[log] [tgz]
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Sat Feb 18 08:53:00 2023 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Sat Feb 18 08:53:00 2023 +0000
treef6f512d88043f81a689e801b14700cadbc4b3ff7
parent6e66f290ec46aae5216306cd09dac5fe64bd9c3f [diff]
parentcd47bfd48b6424a8b2169021d19e36081a9d7774 [diff]
Snap for 9626534 from cd47bfd48b6424a8b2169021d19e36081a9d7774 to udc-d1-release

Change-Id: I37e3bb7d9fbf210fcd0c6657bafddc2d96b038ce
tree: f6f512d88043f81a689e801b14700cadbc4b3ff7
  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.