From d772e25995c3400eecf2b6070e0bf3411447c3d1 Mon Sep 17 00:00:00 2001 From: Mark Wielaard Date: Sat, 2 May 2020 16:21:44 +0200 Subject: [PATCH] Remove SGcheck from documentation. 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 | 49 +++---------------------- docs/xml/manual-core.xml | 4 +- docs/xml/manual-intro.xml | 7 ---- 3 files changed, 7 insertions(+), 53 deletions(-) diff --git a/docs/internals/xml-output-protocol4.txt b/docs/internals/xml-output-protocol4.txt index 3703bbd025..461b8a5044 100644 --- a/docs/internals/xml-output-protocol4.txt +++ b/docs/internals/xml-output-protocol4.txt @@ -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: * 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 ... component): - -* TEXT, as defined in FRAME - -* INT, as defined in FRAME - -* TEXT, 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 blocks give - further details. - - ==================================================================== TOOLSPECIFIC definition for Helgrind diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml index 72730ec7bb..50904ff82a 100644 --- a/docs/xml/manual-core.xml +++ b/docs/xml/manual-core.xml @@ -995,8 +995,8 @@ that can report errors, e.g. Memcheck, but not Cachegrind. 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 docs/internals/xml-output-protocol4.txt in the source tree for Valgrind 3.5.0 or later. diff --git a/docs/xml/manual-intro.xml b/docs/xml/manual-intro.xml index 79351ba18b..6f730d1ac0 100644 --- a/docs/xml/manual-intro.xml +++ b/docs/xml/manual-intro.xml @@ -59,13 +59,6 @@ and without disturbing the existing structure. block utilisation, and layout inefficiencies. - - SGcheck 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.. - - BBV is an experimental SimPoint basic block vector generator. It is useful to people doing computer architecture -- 2.47.3