search

llvm / llvm-project

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

clang-include-cleaner documentation #67542

Open JVApen opened 1 year ago

JVApen commented 1 year ago

Hello,

Clang-include-cleaner started out as part of clangd. However, in the Windows installation of LLVM16, this is also available as executable (clang-include-cleaner.exe)

You don't find a lot if you search for documentation on this exe. There is this page which is part of the clangd documentation. However, it does not mention this standalone tool.

There is this page which is part of the clangd check.

And I also wrongfully found this page which is about clang-include-fixer. A very similar tool, though, it works completely differently.

Would it be possible to have a dedicated documentation page for this executable, even if it just redirects to the clangd documentation? That way, you don't get confused with the fixer application. Next to this, it would be very useful if that documentation also mentions that this standalone tool exists.

llvmbot commented 1 year ago

@llvm/issue-subscribers-clang-include-cleaner

Hello, Clang-include-cleaner started out as part of clangd. However, in the Windows installation of LLVM16, this is also available as executable (clang-include-cleaner.exe) You don't find a lot if you search for documentation on this exe. There is [this page](https://clangd.llvm.org/design/include-cleaner) which is part of the clangd documentation. However, it does not mention this standalone tool. There is [this page](https://clang.llvm.org/extra/clang-tidy/checks/misc/include-cleaner.html) which is part of the clangd check. And I also wrongfully found [this page](https://clang.llvm.org/extra/clang-include-fixer.html) which is about clang-include-fixer. A very similar tool, though, it works completely differently. Would it be possible to have a dedicated documentation page for this executable, even if it just redirects to the clangd documentation? That way, you don't get confused with the fixer application. Next to this, it would be very useful if that documentation also mentions that this standalone tool exists.