| Issue |
165741
|
| Summary |
[clang-tidy] Ideas on improving how static analyzer checks appear in the check list
|
| Labels |
clang-tidy
|
| Assignees |
|
| Reporter |
localspook
|
There are two issues with the static analyzer docs right now:
1) The static analyzer checks appear *only* in the list of aliases. I'm worried that this might be a bit confusing and/or reduce their visibility; finding entirely new checks in the list of aliases is a bit unexpected. I propose moving them into the main check list.
2) When a user clicks on a static analyzer check, they get taken to a page which, after 5 seconds, redirects them to the static analyzer docs. There are two things they might see on that page:
a) A single sentence description. 5 seconds is *maybe* enough to read and understand that, but a single sentence is quite uninformative.
b) A whole paragraph. ([example 1](https://clang.llvm.org/extra/clang-tidy/checks/clang-analyzer/security.SetgidSetuidOrder.html), [example 2](https://clang.llvm.org/extra/clang-tidy/checks/clang-analyzer/security.PutenvStackArray.html)). 5 seconds is nowhere near enough to read that, and I expect everyone gets interrupted in the middle of it, which is really not good user experience.
I propose removing the redirect and linking to the static analyzer docs directly.
Thoughts?
![]()
_______________________________________________
llvm-bugs mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-bugs
