From: David Malcolm <dmalcolm@redhat.com>
Date: Wed, 10 Apr 2024 20:43:28 +0000 (-0400)
Subject: analyzer: fixes to internal docs
X-Git-Tag: basepoints/gcc-15~242
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7f6599a201be2a3f7d1d799087e4ba283ec0bee8;p=thirdparty%2Fgcc.git

analyzer: fixes to internal docs

gcc/ChangeLog:
	* doc/analyzer.texi: Various tweaks.

Signed-off-by: David Malcolm <dmalcolm@redhat.com>
---

diff --git a/gcc/doc/analyzer.texi b/gcc/doc/analyzer.texi
index 8eb40272cb71..b53096e7b7d9 100644
--- a/gcc/doc/analyzer.texi
+++ b/gcc/doc/analyzer.texi
@@ -21,6 +21,9 @@
 
 @subsection Overview
 
+At a high-level, we're doing coverage-guided symbolic execution of the
+user's code.
+
 The analyzer implementation works on the gimple-SSA representation.
 (I chose this in the hopes of making it easy to work with LTO to
 do whole-program analysis).
@@ -55,7 +58,9 @@ Next is the heart of the analyzer: we use a worklist to explore state
 within the supergraph, building an "exploded graph".
 Nodes in the exploded graph correspond to <point,@w{ }state> pairs, as in
      "Precise Interprocedural Dataflow Analysis via Graph Reachability"
-     (Thomas Reps, Susan Horwitz and Mooly Sagiv).
+     (Thomas Reps, Susan Horwitz and Mooly Sagiv) - but note that
+we're not using the algorithm described in that paper, just the
+``exploded graph'' terminology.
 
 We reuse nodes for <point, state> pairs we've already seen, and avoid
 tracking state too closely, so that (hopefully) we rapidly converge
@@ -499,7 +504,8 @@ which dumps a @file{SRC.eg.txt} file containing the full @code{exploded_graph}.
 
 Assuming that you have the
 @uref{https://gcc-newbies-guide.readthedocs.io/en/latest/debugging.html,,python support scripts for gdb}
-installed, you can use:
+installed (which you should do, it makes debugging GCC much easier),
+you can use:
 
 @smallexample
 (gdb) break-on-saved-diagnostic