diff mbox series

[pushed] doc: add notes about limitations of -fanalyzer

Message ID 20230201022406.824321-1-dmalcolm@redhat.com
State New
Headers show
Series [pushed] doc: add notes about limitations of -fanalyzer | expand

Commit Message

David Malcolm Feb. 1, 2023, 2:24 a.m. UTC 
Successfully bootstrapped & regrtested on x86_64-pc-linux-gnu.
Pushed to trunk as r13-5613-ga90316c6ceddfb.

gcc/ChangeLog:
	* doc/invoke.texi (Static Analyzer Options): Add notes about
	limitations of -fanalyzer.

Signed-off-by: David Malcolm <dmalcolm@redhat.com>
---
 gcc/doc/invoke.texi | 7 +++++++
 1 file changed, 7 insertions(+)
diff mbox series

Patch

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 06d77983e30..ddeeea5ccb4 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -10064,6 +10064,13 @@  code, and issues warnings for problems found on them.
 
 This analysis is much more expensive than other GCC warnings.
 
+In technical terms, it performs coverage-guided symbolic execution of
+the code being compiled.  It is neither sound nor complete: it can
+have false positives and false negatives.  It is a bug-finding tool,
+rather than a tool for proving program correctness.
+
+The analyzer is only suitable for use on C code in this release.
+
 Enabling this option effectively enables the following warnings:
 
 @gccoptlist{ @gol