search

llvm / llvm-project

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

clang-analyzer.llvm.org/available_checks.html is still "slated to contain a list of the current checks" #10125

Open FlashSheridan opened 13 years ago

FlashSheridan commented 13 years ago
Bugzilla Link 9753
Version unspecified
OS All
CC @FlashSheridan,@AnnaZaks,@tkremenek

Extended Description

The analyzer "Available Checks" web page (http://clang-analyzer.llvm.org/available_checks.html) still says "This page is slated to contain a list of the current checks the analyzer performs along with some self-contained code examples. In the meantime…," rather than listing the available checkers. The Wayback Machine archive doesn't have the page (perhaps because of a now-deleted clang-analyzer.llvm.org/robots.txt file), but I believe the page has been slated to contain the checkers for quite some time.

The list of checker is quite important for prospective users of a static analysis tool. (Perhaps too much so; I've seen someone choose a tool based primarily on the number of checkers it had.) Cp. Klocwork's list, which is now public:
http://www.klocwork.com/products/documentation/current/Detected_C_and_C%2B%2B_Issues

0f73b9cf-134f-41af-a8b1-14d9f305ee95 commented 12 years ago

Ideally, we would have a script that extracts all non-experimental checkers with short documentation from the Checkers.td. Further, we could make each checker name a link that provides additional (manually written documentation).

However, this still does not solve the issue of finding out what each analyzer warning means (I don't think that we currently associate warnings with checker names).

tkremenek commented 12 years ago

No, I think we should still provide real documentation for all the checkers.

FlashSheridan commented 12 years ago

This was fixed in change 143788 the day after I filed this. cfe/trunk/www/analyzer/available_checks.html doesn’t seem to be updated as often as cfe/trunk/lib/StaticAnalyzer/Checkers/Checkers.td, but that may be a conscious decision, in which case I recommend closing this.

FlashSheridan commented 13 years ago

It would help in the interim to add a link to the list of checkers and help text in the source, https://llvm.org/viewvc/llvm-project/cfe/trunk/lib/StaticAnalyzer/Checkers/Checkers.td?view=co.

FlashSheridan commented 13 years ago

assigned to @tkremenek