[clang][docs] Add all clang-tools-extra to 'ClangTools.rst'#148622
Conversation
|
@llvm/pr-subscribers-clang Author: Manas (weirdsmiley) ChangesThe 'Extra Clang Tools' section does not mention any other clang tool except clang-tidy. This adds all missing extra tools to sync documentation between this page and the main page of Extra Clang Tools. Fixes #148538 Full diff: https://github.com/llvm/llvm-project/pull/148622.diff 1 Files Affected:
diff --git a/clang/docs/ClangTools.rst b/clang/docs/ClangTools.rst
index 60e21590f9eb3..25cdd69d19cdc 100644
--- a/clang/docs/ClangTools.rst
+++ b/clang/docs/ClangTools.rst
@@ -97,6 +97,41 @@ linter tool. It provides an extensible framework for building compiler-based
static analyses detecting and fixing bug-prone patterns, performance,
portability and maintainability issues.
+``clang-include-fixer``
+-----------------------
+
+`clang-include-fixer <https://clang.llvm.org/extra/clang-include-fixer.html>`_
+automates the addition of missing ``#include`` directives in a C++ file. It adds
+missing namespace qualifiers to unidentified symbols when necessary.
+
+``modularize``
+--------------
+
+`modularize <https://clang.llvm.org/extra/modularize.html>`_ is a standalone
+tool that checks whether a set of headers provides the consistent definitions
+required to use modules.
+
+``pp-trace``
+------------
+
+`pp-trace <https://clang.llvm.org/extra/pp-trace.html>`_ is a standalone tool
+that traces preprocessor activity. It’s also used as a test of Clang’s
+PPCallbacks interface. It runs a given source file through the Clang
+preprocessor, displaying selected information from callback functions overridden
+in a PPCallbacks derivation. The output is in a high-level YAML format,
+described in pp-trace Output Format.
+
+``clangd``
+----------
+
+`clangd <https://clangd.llvm.org/>`_ is a language server that can work with
+many editors via a plugin.
+
+``clang-doc``
+-------------
+
+`clang-doc <https://clang.llvm.org/extra/clang-doc.html>`_ is a tool for
+generating C and C++ documentation from source code and comments.
Ideas for new Tools
===================
|
vbvictor
left a comment
There was a problem hiding this comment.
LGTM, but please wait some time for EugeneZelenko to leave a review.
|
Maybe this has been already discussed, but it feels strange to me to capitalize the names of the tools, like Clang-Tidy. Why is that? I don't know what is "correct" in this case, do we have such a pattern in other documents? |
This is how tools are named themself when written as plain text (not with |
The 'Extra Clang Tools' section does not mention any other clang tool except clang-tidy. This adds all missing extra tools to sync documentation between this page and the main page of Extra Clang Tools. Fixes llvm#148538
) The 'Extra Clang Tools' section does not mention any other clang tool except clang-tidy. This adds all missing extra tools to sync documentation between this page and the main page of Extra Clang Tools. Fixes llvm#148538
The 'Extra Clang Tools' section does not mention any other clang tool except clang-tidy. This adds all missing extra tools to sync documentation between this page and the main page of Extra Clang Tools.
Fixes #148538