dkrupp added inline comments.

================
Comment at: clang/docs/analyzer/checkers.rst:2371
+diagnostics) for functions that are defined in the POSIX standard. This option
+is disabled by default.
+
----------------
I think it would be useful for the user to see one example per constraint type 
that this checker supports.
RangeConstraint (was covered), ComparisonConstraint, ValueConstraint, Not null  
Constraint, BufferSize constraint etc.


It would be also nice to add a section "Limitations".

Describe there well known false positive cases or limitations in the bug 
diagnostics that limits understandability.
Essentially the most important well known cases why this checker is alpha.

This section would be useful for users to understand and help identifying cases 
that are known false positives and for the developers to know how to improve 
this checker. I remember many cases when we had to test multiple times "why a 
checker is in alpha", because we forgot about it. I think it is best to 
document it.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D117568/new/

https://reviews.llvm.org/D117568

_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to