[clang-tidy] Organize check doc files into subdirectories (NFC)

- Rename doc files to subdirs by module
- Update release notes and check list to use subdirs
- Update add_new_check.py to handle doc subdirs

Differential Revision: https://reviews.llvm.org/D126495

Author: LegalizeAdulthood

clang-tools-extra/clang-tidy/abseil/CleanupCtadCheck.h

@@ -20,7 +20,7 @@ namespace abseil {
 /// deduction (CTAD), in C++17 and higher.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-cleanup-ctad.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/cleanup-ctad.html
 class CleanupCtadCheck : public utils::TransformerClangTidyCheck {
 public:
   CleanupCtadCheck(StringRef Name, ClangTidyContext *Context);

clang-tools-extra/clang-tidy/abseil/DurationAdditionCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// ``absl::Time`` domain.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-addition.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/duration-addition.html
 class DurationAdditionCheck : public ClangTidyCheck {
 public:
   DurationAdditionCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/DurationComparisonCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// domain.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-comparison.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/duration-comparison.html
 class DurationComparisonCheck : public ClangTidyCheck {
 public:
   DurationComparisonCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/DurationConversionCastCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// the right conversion function instead.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-conversion-cast.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/duration-conversion-cast.html
 class DurationConversionCastCheck : public ClangTidyCheck {
 public:
   DurationConversionCastCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/DurationDivisionCheck.h

@@ -18,7 +18,7 @@ namespace abseil {
 // Find potential incorrect uses of integer division of absl::Duration objects.
 //
 // For the user-facing documentation see: 
-// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-division.html
+// http://clang.llvm.org/extra/clang-tidy/checks/abseil/duration-division.html
 
 class DurationDivisionCheck : public ClangTidyCheck {
 public:

clang-tools-extra/clang-tidy/abseil/DurationFactoryFloatCheck.h

@@ -21,7 +21,7 @@ namespace abseil {
 /// component.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-factory-float.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/duration-factory-float.html
 class DurationFactoryFloatCheck : public ClangTidyCheck {
 public:
   DurationFactoryFloatCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/DurationFactoryScaleCheck.h

@@ -21,7 +21,7 @@ namespace abseil {
 /// case of zero and suggests `ZeroDuration()`.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-factory-scale.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/duration-factory-scale.html
 class DurationFactoryScaleCheck : public ClangTidyCheck {
 public:
   DurationFactoryScaleCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/DurationSubtractionCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// `absl::Duration` domain.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-subtraction.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/duration-subtraction.html
 class DurationSubtractionCheck : public ClangTidyCheck {
 public:
   DurationSubtractionCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/DurationUnnecessaryConversionCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// to numeric types and back again.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-unnecessary-conversion.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/duration-unnecessary-conversion.html
 class DurationUnnecessaryConversionCheck : public ClangTidyCheck {
 public:
   DurationUnnecessaryConversionCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/FasterStrsplitDelimiterCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// is a single character string literal and replaces it with a character.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-faster-strsplit-delimiter.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/faster-strsplit-delimiter.html
 class FasterStrsplitDelimiterCheck : public ClangTidyCheck {
 public:
   FasterStrsplitDelimiterCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/NoInternalDependenciesCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// against doing so.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-no-internal-dependencies.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/no-internal-dependencies.html
 class NoInternalDependenciesCheck : public ClangTidyCheck {
 public:
   NoInternalDependenciesCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/NoNamespaceCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// Abseil's compatibility guidelines.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-no-namespace.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/no-namespace.html
 class NoNamespaceCheck : public ClangTidyCheck {
 public:
   NoNamespaceCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/RedundantStrcatCallsCheck.h

@@ -22,7 +22,7 @@ namespace abseil {
 ///   StrCat(1, StrCat(2, 3))  ==>  StrCat(1, 2, 3)
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-redundant-strcat-calls.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/redundant-strcat-calls.html
 class RedundantStrcatCallsCheck : public ClangTidyCheck {
 public:
   RedundantStrcatCallsCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/StrCatAppendCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// should be used instead. 
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-str-cat-append.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/str-cat-append.html
 class StrCatAppendCheck : public ClangTidyCheck {
 public:
   StrCatAppendCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/StringFindStrContainsCheck.h

@@ -20,7 +20,7 @@ namespace abseil {
 /// types) and suggests replacing with absl::StrContains.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-string-find-str-contains.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/string-find-str-contains.html
 class StringFindStrContainsCheck : public utils::TransformerClangTidyCheck {
 public:
   StringFindStrContainsCheck(StringRef Name, ClangTidyContext *Context);

clang-tools-extra/clang-tidy/abseil/TimeComparisonCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// domain.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-time-comparison.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/time-comparison.html
 class TimeComparisonCheck : public ClangTidyCheck {
 public:
   TimeComparisonCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/TimeSubtractionCheck.h

@@ -19,7 +19,7 @@ namespace abseil {
 /// in the time domain instead of the numeric domain.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-time-subtraction.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/time-subtraction.html
 class TimeSubtractionCheck : public ClangTidyCheck {
 public:
   TimeSubtractionCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/abseil/UpgradeDurationConversionsCheck.h

@@ -21,7 +21,7 @@ namespace abseil {
 /// Finds deprecated uses of `absl::Duration` arithmetic operators and factories.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/abseil-upgrade-duration-conversions.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/abseil/upgrade-duration-conversions.html
 class UpgradeDurationConversionsCheck : public ClangTidyCheck {
 public:
   UpgradeDurationConversionsCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/add_new_check.py

@@ -54,7 +54,6 @@ def adapt_cmake(module_path, check_name_camel):
 
 # Adds a header for the new check.
 def write_header(module_path, module, namespace, check_name, check_name_camel):
-  check_name_dashes = module + '-' + check_name
   filename = os.path.join(module_path, check_name_camel) + '.h'
   print('Creating %s...' % filename)
   with io.open(filename, 'w', encoding='utf8', newline='\n') as f:
@@ -85,10 +84,10 @@ def write_header(module_path, module, namespace, check_name, check_name_camel):
 /// FIXME: Write a short description.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/%(check_name_dashes)s.html
-class %(check_name)s : public ClangTidyCheck {
+/// http://clang.llvm.org/extra/clang-tidy/checks/%(module)s/%(check_name)s.html
+class %(check_name_camel)s : public ClangTidyCheck {
 public:
-  %(check_name)s(StringRef Name, ClangTidyContext *Context)
+  %(check_name_camel)s(StringRef Name, ClangTidyContext *Context)
       : ClangTidyCheck(Name, Context) {}
   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
@@ -100,8 +99,8 @@ class %(check_name)s : public ClangTidyCheck {
 
 #endif // %(header_guard)s
 """ % {'header_guard': header_guard,
-       'check_name': check_name_camel,
-       'check_name_dashes': check_name_dashes,
+       'check_name_camel': check_name_camel,
+       'check_name': check_name,
        'module': module,
        'namespace': namespace})
 
@@ -266,11 +265,11 @@ def add_release_notes(module_path, module, check_name):
         if header_found and add_note_here:
           if not line.startswith('^^^^'):
             f.write("""- New :doc:`%s
-  <clang-tidy/checks/%s>` check.
+  <clang-tidy/checks/%s/%s>` check.
 
   FIXME: add release notes.
 
-""" % (check_name_dashes, check_name_dashes))
+""" % (check_name_dashes, module, check_name))
             note_added = True
 
       f.write(line)
@@ -321,8 +320,11 @@ def update_checks_list(clang_tidy_path):
   with io.open(filename, 'r', encoding='utf8') as f:
     lines = f.readlines()
   # Get all existing docs
-  doc_files = list(filter(lambda s: s.endswith('.rst') and s != 'list.rst',
-                     os.listdir(docs_dir)))
+  doc_files = []
+  for subdir in list(filter(lambda s: not s.endswith('.rst') and not s.endswith('.py'),
+                     os.listdir(docs_dir))):
+    for file in filter(lambda s: s.endswith('.rst'), os.listdir(os.path.join(docs_dir, subdir))):
+      doc_files.append([subdir, file])
   doc_files.sort()
 
   # We couldn't find the source file from the check name, so try to find the
@@ -422,26 +424,28 @@ def has_auto_fix(check_name):
     return ''
 
   def process_doc(doc_file):
-    check_name = doc_file.replace('.rst', '')
+    check_name = doc_file[0] + '-' + doc_file[1].replace('.rst', '')
 
-    with io.open(os.path.join(docs_dir, doc_file), 'r', encoding='utf8') as doc:
+    with io.open(os.path.join(docs_dir, *doc_file), 'r', encoding='utf8') as doc:
       content = doc.read()
       match = re.search('.*:orphan:.*', content)
 
       if match:
         # Orphan page, don't list it.
         return '', ''
 
-      match = re.search('.*:http-equiv=refresh: \d+;URL=(.*).html.*',
+      match = re.search('.*:http-equiv=refresh: \d+;URL=(.*).html(.*)',
                         content)
       # Is it a redirect?
       return check_name, match
 
   def format_link(doc_file):
     check_name, match = process_doc(doc_file)
     if not match and check_name:
-      return '   `%(check)s <%(check)s.html>`_,%(autofix)s\n' % {
-        'check': check_name,
+      return '   `%(check_name)s <%(module)s/%(check)s.html>`_,%(autofix)s\n' % {
+        'check_name': check_name,
+        'module': doc_file[0],
+        'check': doc_file[1].replace('.rst', ''),
         'autofix': has_auto_fix(check_name)
       }
     else:
@@ -450,16 +454,27 @@ def format_link(doc_file):
   def format_link_alias(doc_file):
     check_name, match = process_doc(doc_file)
     if match and check_name:
+      module = doc_file[0]
+      check_file = doc_file[1].replace('.rst', '')
       if match.group(1) == 'https://clang.llvm.org/docs/analyzer/checkers':
-        title_redirect = 'Clang Static Analyzer'
+        title = 'Clang Static Analyzer ' + check_file
+        # Preserve the anchor in checkers.html from group 2.
+        target = match.group(1) + '.html' + match.group(2)
+        autofix = ''
       else:
-        title_redirect = match.group(1)
+        redirect_parts = re.search('^\.\./([^/]*)/([^/]*)$', match.group(1))
+        title = redirect_parts[1] + '-' + redirect_parts[2]
+        target = redirect_parts[1] + '/' + redirect_parts[2] + '.html'
+        autofix = has_auto_fix(title)
+
       # The checker is just a redirect.
-      return '   `%(check)s <%(check)s.html>`_, `%(title)s <%(target)s.html>`_,%(autofix)s\n' % {
-        'check': check_name,
-        'target': match.group(1),
-        'title': title_redirect,
-        'autofix': has_auto_fix(match.group(1))
+      return '   `%(check_name)s <%(module)s/%(check_file)s.html>`_, `%(title)s <%(target)s>`_,%(autofix)s\n' % {
+        'check_name': check_name,
+        'module': module,
+        'check_file': check_file,
+        'target': target,
+        'title': title,
+        'autofix': autofix
       }
     return ''
 
@@ -486,7 +501,7 @@ def format_link_alias(doc_file):
 def write_docs(module_path, module, check_name):
   check_name_dashes = module + '-' + check_name
   filename = os.path.normpath(os.path.join(
-      module_path, '../../docs/clang-tidy/checks/', check_name_dashes + '.rst'))
+      module_path, '../../docs/clang-tidy/checks/', module, check_name + '.rst'))
   print('Creating %s...' % filename)
   with io.open(filename, 'w', encoding='utf8', newline='\n') as f:
     f.write(""".. title:: clang-tidy - %(check_name_dashes)s

clang-tools-extra/clang-tidy/altera/IdDependentBackwardBranchCheck.h

@@ -20,7 +20,7 @@ namespace altera {
 /// degradation.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/altera-id-dependent-backward-branch.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/altera/id-dependent-backward-branch.html
 class IdDependentBackwardBranchCheck : public ClangTidyCheck {
 private:
   enum LoopType { UnknownLoop = -1, DoLoop = 0, WhileLoop = 1, ForLoop = 2 };

clang-tools-extra/clang-tidy/altera/KernelNameRestrictionCheck.h

@@ -19,7 +19,7 @@ namespace altera {
 /// `Verilog.cl`, or `VHDL.cl`.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/altera-kernel-name-restriction.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/altera/kernel-name-restriction.html
 class KernelNameRestrictionCheck : public ClangTidyCheck {
 public:
   KernelNameRestrictionCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/altera/SingleWorkItemBarrierCheck.h

@@ -20,7 +20,7 @@ namespace altera {
 /// kernels, which may be inefficient or cause an error.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/opencl-single-work-item-barrier.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/opencl/single-work-item-barrier.html
 class SingleWorkItemBarrierCheck : public ClangTidyCheck {
   const unsigned AOCVersion;
 

clang-tools-extra/clang-tidy/altera/StructPackAlignCheck.h

@@ -19,7 +19,7 @@ namespace altera {
 /// packing and/or aligning of said structs as needed.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/altera-struct-pack-align.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/altera/struct-pack-align.html
 class StructPackAlignCheck : public ClangTidyCheck {
 public:
   StructPackAlignCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/altera/UnrollLoopsCheck.h

@@ -23,7 +23,7 @@ namespace altera {
 /// they cannot be fully unrolled, and should be partially unrolled.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/altera-unroll-loops.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/altera/unroll-loops.html
 class UnrollLoopsCheck : public ClangTidyCheck {
 public:
   UnrollLoopsCheck(StringRef Name, ClangTidyContext *Context);

clang-tools-extra/clang-tidy/android/CloexecAccept4Check.h

@@ -18,7 +18,7 @@ namespace android {
 /// Finds code that uses accept4() without using the SOCK_CLOEXEC flag.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-accept4.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/android/cloexec-accept4.html
 class CloexecAccept4Check : public CloexecCheck {
 public:
   CloexecAccept4Check(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/android/CloexecAcceptCheck.h

@@ -18,7 +18,7 @@ namespace android {
 /// accept() is better to be replaced by accept4().
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-accept.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/android/cloexec-accept.html
 class CloexecAcceptCheck : public CloexecCheck {
 public:
   CloexecAcceptCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/android/CloexecCreatCheck.h

@@ -18,7 +18,7 @@ namespace android {
 /// creat() is better to be replaced by open().
 /// Find the usage of creat() and redirect user to use open().
 
-/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-creat.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/android/cloexec-creat.html
 class CloexecCreatCheck : public CloexecCheck {
 public:
   CloexecCreatCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/android/CloexecDupCheck.h

@@ -19,7 +19,7 @@ namespace android {
 /// Find the usage of dup() and redirect user to use fcntl().
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-dup.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/android/cloexec-dup.html
 class CloexecDupCheck : public CloexecCheck {
 public:
   CloexecDupCheck(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/android/CloexecEpollCreate1Check.h

@@ -18,7 +18,7 @@ namespace android {
 /// Finds code that uses epoll_create1() without using the EPOLL_CLOEXEC flag.
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-epoll-create1.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/android/cloexec-epoll-create1.html
 class CloexecEpollCreate1Check : public CloexecCheck {
 public:
   CloexecEpollCreate1Check(StringRef Name, ClangTidyContext *Context)

clang-tools-extra/clang-tidy/android/CloexecEpollCreateCheck.h

@@ -18,7 +18,7 @@ namespace android {
 /// epoll_create() is better to be replaced by epoll_create1().
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-epoll-create.html
+/// http://clang.llvm.org/extra/clang-tidy/checks/android/cloexec-epoll-create.html
 class CloexecEpollCreateCheck : public CloexecCheck {
 public:
   CloexecEpollCreateCheck(StringRef Name, ClangTidyContext *Context)