Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/aml_wif_341610000
tagc2d62620918c415b6d10fbd86b0ca3024b19a3be
taggerThe Android Open Source Project <initial-contribution@android.com>Wed Apr 24 20:11:22 2024 -0700
object91016155f3d3634e5ab907d3f898ef50cd5a0bce 
aml_wif_341610000 (11391728,com.google.android.wifi)
commit91016155f3d3634e5ab907d3f898ef50cd5a0bce[log] [tgz]
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Thu Nov 02 22:46:14 2023 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Thu Nov 02 22:46:14 2023 +0000
tree553e7b88ace45b163b9ea300143c04c17e273021
parenta7973ad7e3ea404bf1931a5fc082bad9de167f44 [diff]
parentc87dfb8f95d182daebdfeda7275a4debdd4b03a7 [diff]
Snap for 11041982 from c87dfb8f95d182daebdfeda7275a4debdd4b03a7 to mainline-wifi-release

Change-Id: I72de4263515c0fd0f16afdde4c398d1ce4eb37d4
tree: 553e7b88ace45b163b9ea300143c04c17e273021
  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.