]> git.ipfire.org Git - thirdparty/valgrind.git/commitdiff
Remove SGcheck from documentation.
authorMark Wielaard <mark@klomp.org>
Sat, 2 May 2020 14:21:44 +0000 (16:21 +0200)
committerMark Wielaard <mark@klomp.org>
Sat, 2 May 2020 14:21:58 +0000 (16:21 +0200)
Since the SGcheck tool was removed for 3.16.0, also remove it from the
manual intro and core sections and the xml-output-protocol4 description.

docs/internals/xml-output-protocol4.txt
docs/xml/manual-core.xml
docs/xml/manual-intro.xml

index 3703bbd0250b806ba90c387c34a5260be6903719..461b8a50445a642badb898788911d177363a57a1 100644 (file)
@@ -4,7 +4,7 @@
 14 October 2011
 
 Protocols 1 through 3 supported Memcheck only.  Protocol 4 provides
-XML output for Memcheck, Helgrind, DRD and SGcheck.  Technically there
+XML output for Memcheck, Helgrind and DRD.  Technically there
 are four variants of Protocol 4, one for each tool, since they
 produce different errors.  The four variants differ only in the
 definition of the ERROR nonterminal and are otherwise identical.
@@ -81,7 +81,7 @@ XWHAT, and between AUXWHAT and XAUXWHAT.
 The definition of Protocol 4 now follows.  It is structured similarly
 to that of the previous protocols, except that there is a separate
 definition of a nonterminal called TOOLSPECIFIC for each of Memcheck,
-Helgrind, DRD and SGcheck.  The XWHAT and XAUXWHAT nonterminals also
+Helgrind and DRD.  The XWHAT and XAUXWHAT nonterminals also
 have tool-specific components.  Apart from that, the structure is
 common to all supported tools.
 
@@ -199,9 +199,9 @@ the following in sequence:
      </status>
 
 * Zero or more of (either ERRORCOUNTS or TOOLSPECIFIC).  In Memcheck's
-  case these will be complaints from the leak checker.  For SGcheck
-  and Helgrind we don't expect any output here (but the spec does not
-  guarantee that either).
+  case these will be complaints from the leak checker.  For Helgrind
+  we don't expect any output here (but the spec does not guarantee that
+  either).
 
 * SUPPCOUNTS, indicating how many times each suppression was used.
 
@@ -571,45 +571,6 @@ The possible values are:
       indicating probable integer overflow or cast from negative signed
 
 
-====================================================================
-
-TOOLSPECIFIC definition for SGcheck
------------------------------------
-
-For SGcheck, a TOOLSPECIFIC is simply an ERROR:
-
-TOOLSPECIFIC = ERROR
-
-
-ERROR details for SGcheck
--------------------------
-
-SGcheck does not produce any XWHAT records, despite the fact that
-"ERROR definition -- common structure" says that tools may do so.
-
-
-XAUXWHATs (for definition, see above) may contain the following extra
-components (along with the mandatory <text>...</text> component):
-
-* <file>TEXT</file>, as defined in FRAME
-
-* <line>INT</line>, as defined in FRAME
-
-* <dir>TEXT</dir>, as defined in FRAME
-
-
-KIND for SGcheck
-----------------
-This is a small enumeration indicating roughly the nature of an error.
-The possible values are:
-
-   SorG
-
-      Stack or global array inconsistency (roughly speaking, an
-      overrun of a stack or global array).  The <auxwhat> blocks give
-      further details.
-
-
 ====================================================================
 
 TOOLSPECIFIC definition for Helgrind
index 72730ec7bbfe57671db60cfb6ec1013ce4f86a9b..50904ff82ab74d1aa4b1f49a98895d1a36c0b2e8 100644 (file)
@@ -995,8 +995,8 @@ that can report errors, e.g. Memcheck, but not Cachegrind.</para>
 
       <para>This option is aimed at making life easier for tools that consume
       Valgrind's output as input, such as GUI front ends.  Currently this
-      option works with Memcheck, Helgrind, DRD and SGcheck.  The output
-      format is specified in the file
+      option works with Memcheck, Helgrind and DRD.  The output format is
+      specified in the file
       <computeroutput>docs/internals/xml-output-protocol4.txt</computeroutput>
       in the source tree for Valgrind 3.5.0 or later.</para>
 
index 79351ba18b8126c58c5494225b1f68151b7bba85..6f730d1ac07fe866dd89617e05ee3a96d90e0a46 100644 (file)
@@ -59,13 +59,6 @@ and without disturbing the existing structure.</para>
     block utilisation, and layout inefficiencies.</para>
   </listitem>
 
-  <listitem>
-    <para><command>SGcheck</command> is an experimental tool that can
-    detect overruns of stack and global arrays.  Its functionality is
-    complementary to that of Memcheck: SGcheck finds problems that
-    Memcheck can't, and vice versa..</para>
-  </listitem>
-
   <listitem>
     <para><command>BBV</command> is an experimental SimPoint basic block
     vector generator.  It is useful to people doing computer architecture