[analyzer] ClangSA should tablegen doc urls refering to the main doc page

[steakhal]

Summary

AFAIK we should prefer
https://clang.llvm.org/docs/analyzer/checkers.html to https://clang-analyzer.llvm.org/{available_checks,alpha_checks}.html

This patch will ensure that the doc urls produced by tablegen for the
ClangSA, will use the new url. Nothing else will be changed.

[Szelethus]

Nice!

clang/utils/TableGen/ClangSACheckersEmitter.cpp

27

Do you foresee a change in the default separator? I think an eventual shift away from packages is more likely (see https://discourse.llvm.org/t/analyzer-refactoring-analyzeroptions/50160/5).

I this an unnecessary complexity, but its not a hill I will die on.

edit: I just realized that you need this for the url, so never mind. I grave dug a 3 yr old topic on discourse because of it :^) Oops.

[steakhal]

Fix the single case when the Sep was not forwarded.

[steakhal]

I'd like to reach a wider consensus regarding this patch. @aaron.ballman @NoQ

[martong]

clang/utils/TableGen/ClangSACheckersEmitter.cpp

89–90

This patch will ensure that the doc urls produced by tablegen for the ClangSA, will use the new url. Nothing else will be changed.

If that was the case then we'd need only this hunk of change plus the test file. Perhaps it would make sense to either split this to more patches

• Adding Sep
• Handling missing documentation
• new url

Or please change the description of the patch about these changes.

[steakhal]

Now it should be much smaller.
Sorry for not doing this in the first place.

clang/utils/TableGen/ClangSACheckersEmitter.cpp

89–90

Thanks, done.

[whisperity]

(Side note: you should avoid the list-expansion syntax in URLs because browsers do not understand them and result in links that are not leading anywhere.)

I like this. We should continue getting to the point where the documentation is having a uniform layout.

[ASDenysPetrov]

Thanks! LGTM.

clang/utils/TableGen/ClangSACheckersEmitter.cpp

87–90

IMO it's a bit messy here.

clang/test/Analysis/diagnostics/Inputs/expected-sarif/sarif-multi-diagnostic-test.c.sarif

"runs": [
               },
               "id": "debug.TaintTest",
               "name": "debug.TaintTest"
             },
             {
               "fullDescription": {
                 "text": "Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)"
               },
-              "helpUri": "https://clang-analyzer.llvm.org/available_checks.html#core.CallAndMessage",
+              "helpUri": "https://clang.llvm.org/docs/analyzer/checkers.html#core-callandmessage",
               "id": "core.CallAndMessage",
               "name": "core.CallAndMessage"
             },
             {
               "fullDescription": {
                 "text": "Check for division by zero"
               },
-              "helpUri": "https://clang-analyzer.llvm.org/available_checks.html#core.DivideZero",
+              "helpUri": "https://clang.llvm.org/docs/analyzer/checkers.html#core-dividezero",
               "id": "core.DivideZero",
               "name": "core.DivideZero"
             },
             {
               "fullDescription": {
                 "text": "Check for memory leaks, double free, and use-after-free problems. Traces memory managed by malloc()/free()."
               },
-              "helpUri": "https://clang-analyzer.llvm.org/available_checks.html#unix.Malloc",
+              "helpUri": "https://clang.llvm.org/docs/analyzer/checkers.html#unix-malloc",
               "id": "unix.Malloc",
               "name": "unix.Malloc"
             }
           ],
         }
       }
     }
   ],
 }

clang/utils/TableGen/ClangSACheckersEmitter.cpp

 #include <string>
 
 using namespace llvm;
 
 //===----------------------------------------------------------------------===//
 // Static Analyzer Checkers Tables generation
 //===----------------------------------------------------------------------===//
 
 static std::string getPackageFullName(const Record *R, StringRef Sep = ".");
 
 static std::string getParentPackageFullName(const Record *R,
                                             StringRef Sep = ".") {
   std::string name;
   if (DefInit *DI = dyn_cast<DefInit>(R->getValueInit("ParentPackage")))
     name = getPackageFullName(DI->getDef(), Sep);
   return name;
 }
for (unsigned i = 0, e = B->getNumBits(); i != e; ++i) {
     else
       PrintFatalError(R.getLoc(),
                       "missing Documentation for " + getCheckerFullName(&R));
   }
   return Value;
 }
 
 static std::string getCheckerDocs(const Record &R) {
-  StringRef LandingPage;
   const BitsInit *BI = R.getValueAsBitsInit("Documentation");
   if (!BI)
     PrintFatalError(R.getLoc(), "missing Documentation<...> member for " +
                                     getCheckerFullName(&R));
 
-  uint64_t V = getValueFromBitsInit(BI, R);
-  if (V == 1)
-    LandingPage = "available_checks.html";
-  else if (V == 2)
-    LandingPage = "alpha_checks.html";
-
-  if (LandingPage.empty())
+  // Ignore 'Documentation<NotDocumented>' checkers.
+  if (getValueFromBitsInit(BI, R) == 0)
     return "";
 
-  return (llvm::Twine("https://clang-analyzer.llvm.org/") + LandingPage + "#" +
-          getCheckerFullName(&R))
+  std::string CheckerFullName = StringRef(getCheckerFullName(&R, "-")).lower();
+  return (llvm::Twine("https://clang.llvm.org/docs/analyzer/checkers.html#") +
+          CheckerFullName)
       .str();
 }
 
 /// Retrieves the type from a CmdOptionTypeEnum typed Record object. Note that
 /// the class itself has to be modified for adding a new option type in
 /// CheckerBase.td.
 static std::string getCheckerOptionType(const Record &R) {
   if (BitsInit *BI = R.getValueAsBitsInit("Type")) {
     switch(getValueFromBitsInit(BI, R)) {