search

llvm / llvm-project

The LLVM Project is a collection of modular and reusable compiler and toolchain technologies.
http://llvm.org
Other
26.68k stars 10.93k forks source link

[clang-tidy][docs] `run-clang-tidy.py` is undocumented in `Using clang-tidy` #90772

Open 5chmidti opened 2 months ago

5chmidti commented 2 months ago

The Using clang-tidy section (https://clang.llvm.org/extra/clang-tidy/index.html) (or somewhere else) should explain the run-clang-tidy.py script. Currently, the only mention is in the Getting Involved docs (https://clang.llvm.org/extra/clang-tidy/Contributing.html) where it is explained how to run a check on the LLVM repo to test a check, however users of clang-tidy are less likely to visit and read that page than the Using clang-tidy section.

-> Add a short explanation on what the script does and how to use it.

llvmbot commented 2 months ago

Hi!

This issue may be a good introductory issue for people new to working on LLVM. If you would like to work on this issue, your first steps are:

  1. Check that no other contributor has already been assigned to this issue. If you believe that no one is actually working on it despite an assignment, ping the person. After one week without a response, the assignee may be changed.
  2. In the comments of this issue, request for it to be assigned to you, or just create a pull request after following the steps below. Mention this issue in the description of the pull request.
  3. Fix the issue locally.
  4. Run the test suite locally. Remember that the subdirectories under test/ create fine-grained testing targets, so you can e.g. use make check-clang-ast to only run Clang's AST tests.
  5. Create a Git commit.
  6. Run git clang-format HEAD~1 to format your changes.
  7. Open a pull request to the upstream repository on GitHub. Detailed instructions can be found in GitHub's documentation. Mention this issue in the description of the pull request.

If you have any further questions about this issue, don't hesitate to ask via a comment in the thread below.

llvmbot commented 2 months ago

@llvm/issue-subscribers-good-first-issue

Author: Julian Schmidt (5chmidti)

The `Using clang-tidy` section (https://clang.llvm.org/extra/clang-tidy/index.html) (or somewhere else) should explain the `run-clang-tidy.py` script. Currently, the only mention is in the `Getting Involved` docs (https://clang.llvm.org/extra/clang-tidy/Contributing.html) where it is explained how to run a check on the LLVM repo to test a check. -> Add a short explanation on what the script does and how to use it.
youngsun4786 commented 1 month ago

@5chmidti , is this issue still open to work? It's my first time contributing to llvm, and I would like to work get started!

5chmidti commented 1 month ago

Yes, it is still open, go ahead. FYI, the file in question is https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/clang-tidy/index.rst

youngsun4786 commented 1 month ago

Yes, it is still open, go ahead. FYI, the file in question is https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/clang-tidy/index.rst

Thank you so much for quick follow up! It seems that I cannot assign myself to this issue, would it be possible for you to assign me as well? Thanks