Adding first version for which clang-tidy checks and their options are available #162937
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed on discourse, I have been working on adding the first version for which each clang-tidy checks and their options are available in the documentation.
I have made a Python script (not included in that PR) to track down the available checks/options for each LLVM releases (using the GitHub API to accurately gather/download the releases and then building them from sources).
The draft includes a lot of changes but since those changes were automatically generated by the script, they can easily be tuned if you think they should.
Here is a small summary of the modifications I have made:
clang-tools-extra/docs/clang-tidy/checks/list.rst
file).clang-tools-extra/docs/clang-tidy/checks
subfolders).clang-tools-extra/docs/_static/clang-tools-extra-styles.css
file and add the following code toclang-tools-extra/docs/clang-tidy/checks/list.rst
file to allow me to use strike-through:As I was working on this PR, few questions came to my mind:
I am not sure whether I should mention people (and who) for this draft PR but since you have been following this project on that Discourse discussion, I will invoke you @vbvictor! :p