[Docs][clang-tools-extra] Convert maintainers list to .rst format #165171
Conversation
|
@llvm/pr-subscribers-clang-tools-extra Author: Baranov Victor (vbvictor) ChangesClang maintainers list is already in Full diff: https://github.com/llvm/llvm-project/pull/165171.diff 1 Files Affected:
diff --git a/clang-tools-extra/Maintainers.txt b/clang-tools-extra/Maintainers.rst
similarity index 93%
rename from clang-tools-extra/Maintainers.txt
rename to clang-tools-extra/Maintainers.rst
index 43dfd48ad1f57..7a12ac32958d6 100644
--- a/clang-tools-extra/Maintainers.txt
+++ b/clang-tools-extra/Maintainers.rst
@@ -2,9 +2,13 @@
Clang Tools Extra Maintainers
=============================
-This file is a list of the maintainers
-(https://llvm.org/docs/DeveloperPolicy.html#maintainers) for clang-tools-extra.
+This file is a list of the
+`maintainers <https://llvm.org/docs/DeveloperPolicy.html#maintainers>`_
+for clang-tools-extra.
+.. contents::
+ :depth: 2
+ :local:
Active Maintainers
==================
|
clang-tools-extra/Maintainers.rst
Outdated
| (https://llvm.org/docs/DeveloperPolicy.html#maintainers) for clang-tools-extra. | ||
| This file is a list of the | ||
| `maintainers <https://llvm.org/docs/DeveloperPolicy.html#maintainers>`_ | ||
| for clang-tools-extra. |
There was a problem hiding this comment.
Highlight clang-tools-extra? Also module? directory? Other term?
There was a problem hiding this comment.
Used project as in
"Welcome to the clang-tools-extra project which contains extra tools built using Clang’s tooling APIs."
https://clang.llvm.org/extra/index.html.
WDYT?
There was a problem hiding this comment.
clang-tools-extra seems to me like directory name. There is difference between clang-tidy and Clang-Tidy in documentation. Former should be always used with :program: prefix.
There was a problem hiding this comment.
"Maintainers of XXX directory" don't sound honorable/noble enough to me, and I think this file should be written with sense of honor.
What I consider honorable is "project" or "extra tools built using Clang’s tooling APIs" (copied text from cite)
There was a problem hiding this comment.
https://clang.llvm.org/extra/ uses Extra Clang Tools, so I assume this is official project name.
3 participants
Clang maintainers list is already in
.rstformat, which gives nice visuals.I think we should convert clang-tools-extra maintainers too to
.rst.