[clang-tidy][CI] Add validation of clang-tidy docs.

[vbvictor]

In clang-tidy, we have some established rules of .rst files formatting: 80-characters limits, trailing white spaces, missing or excessive newline at the end, indentation of lists, etc.
Some files in "alphabetical" format (e.g. there are N entries should be in alphabetical order).
Examples of these files are:
https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/clang-tidy/checks/list.rst?plain=1
https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/ReleaseNotes.rst?plain=1

We need a test or a CI-job that will check our .rst files according to those rules.

I suspect it should be a simple python script that we could run as a lit test, like this: #118154

[llvmbot]

@llvm/issue-subscribers-clang-tidy

Author: Baranov Victor (vbvictor)

In clang-tidy, we have some files "alphabetical" format (e.g. there are N entries should be in alphabetical order).

Examples of these files are:
https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/clang-tidy/checks/list.rst?plain=1
https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/ReleaseNotes.rst?plain=1

We need a test or a CI-job that will check that those files are kept alphabetical.

I suspect it should be a simple python script that we could run as a lit test.

[vbvictor]

In https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/ReleaseNotes.rst?plain=1
alphabetical should be:

• New checks
• New check aliases
• Changes in existing checks

[llvmbot]

@llvm/issue-subscribers-infrastructure

Author: Baranov Victor (vbvictor)

In clang-tidy, we have some files "alphabetical" format (e.g. there are N entries should be in alphabetical order).

Examples of these files are:
https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/clang-tidy/checks/list.rst?plain=1
https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/docs/ReleaseNotes.rst?plain=1

We need a test or a CI-job that will check that those files are kept alphabetical.

I suspect it should be a simple python script that we could run as a lit test, like this: #118154

[EugeneZelenko]

It'll be great to add some other documentation linting: 80-characters limits, trailing white spaces, missing or excessive newline at the end, indentation of lists, etc.

It I'm not mistaken, such attempt was made in the Phabricator era, but I could not find it :-(

[vbvictor]

It'll be great to add some other documentation linting: 80-characters limits, trailing white spaces, missing or excessive newline at the end, indentation of lists, etc.

It I'm not mistaken, such attempt was made in the Phabricator era, but I could not find it :-(

Do we have an issue for this to track?

[EugeneZelenko]

It'll be great to add some other documentation linting: 80-characters limits, trailing white spaces, missing or excessive newline at the end, indentation of lists, etc.
It I'm not mistaken, such attempt was made in the Phabricator era, but I could not find it :-(

Do we have an issue for this to track?

I found #65725, but Phabricator patch was created much more early. Fortunately I made comments there about Phabricator patch: https://reviews.llvm.org/D55523 :-)

[vbvictor]

@mydeveloperday, Could we use/modify your script from https://reviews.llvm.org/D55523? Of course, with proper citation.

I think we should start small and make the script/linter only for needs of clang-tidy project.
Then we can extend it to be more general and cover subproject.
I'll take a look at other rst linters and see if they can be applied to us. But I don't think that any linter will have "keep alphabetical" rule so we would still need to implement it ourselves.