From 70af73cc4ff571be058fa8882c699d0a76bc04d5 Mon Sep 17 00:00:00 2001 From: Julian Seward Date: Sun, 26 Jun 2011 19:57:26 +0000 Subject: [PATCH] Remove references to Ptrcheck in the documentation, and replace them as relevant with references to SGcheck. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@11839 --- docs/internals/xml-output-protocol4.txt | 38 +++++++------------------ docs/xml/FAQ.xml | 8 +++--- docs/xml/manual-core.xml | 2 +- docs/xml/manual-intro.xml | 8 +++--- docs/xml/valgrind-manpage.xml | 8 +++--- 5 files changed, 24 insertions(+), 40 deletions(-) diff --git a/docs/internals/xml-output-protocol4.txt b/docs/internals/xml-output-protocol4.txt index 7db5d152ae..c02720730b 100644 --- a/docs/internals/xml-output-protocol4.txt +++ b/docs/internals/xml-output-protocol4.txt @@ -4,7 +4,7 @@ 11 May 2009 Protocols 1 through 3 supported Memcheck only. Protocol 4 provides -XML output for Memcheck, Helgrind and Ptrcheck. Technically there are +XML output for Memcheck, Helgrind and SGcheck. Technically there are three variants of Protocol 4, one for each tool, since they produce different errors. The three variants differ only in the definition of the ERROR nonterminal and are otherwise identical. @@ -82,7 +82,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 and Ptrcheck. The XWHAT and XAUXWHAT nonterminals also have +Helgrind and SGcheck. The XWHAT and XAUXWHAT nonterminals also have tool-specific components. Apart from that, the structure is common to all supported tools. @@ -200,7 +200,7 @@ 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 Ptrcheck + 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). @@ -560,18 +560,18 @@ The possible values are: ==================================================================== -TOOLSPECIFIC definition for Ptrcheck ------------------------------------- +TOOLSPECIFIC definition for SGcheck +----------------------------------- -For Ptrcheck, a TOOLSPECIFIC is simply an ERROR: +For SGcheck, a TOOLSPECIFIC is simply an ERROR: TOOLSPECIFIC = ERROR -ERROR details for Ptrcheck --------------------------- +ERROR details for SGcheck +------------------------- -Ptrcheck does not produce any XWHAT records, despite the fact that +SGcheck does not produce any XWHAT records, despite the fact that "ERROR definition -- common structure" says that tools may do so. @@ -585,8 +585,8 @@ components (along with the mandatory ... component): * TEXT, as defined in FRAME -KIND for Ptrcheck ------------------ +KIND for SGcheck +---------------- This is a small enumeration indicating roughly the nature of an error. The possible values are: @@ -596,22 +596,6 @@ The possible values are: overrun of a stack or global array). The blocks give further details. - Heap - - Usage of a pointer derived from a heap block, to access - outside that heap block - - Arith - - Doing arithmetic on pointers in a way that cannot possibly - result in another valid pointer. Eg, adding two pointer values. - - SysParam - - Special case of "Heap", in which the invalidly-addressed memory - is presented as an argument to a system call which reads or - writes memory. - ==================================================================== diff --git a/docs/xml/FAQ.xml b/docs/xml/FAQ.xml index af197f856c..e0e190bbcb 100644 --- a/docs/xml/FAQ.xml +++ b/docs/xml/FAQ.xml @@ -467,13 +467,13 @@ int main(void) - Unfortunately, Memcheck doesn't do bounds checking on static + Unfortunately, Memcheck doesn't do bounds checking on global or stack arrays. We'd like to, but it's just not possible to do in a reasonable way that fits with how Memcheck works. Sorry. - However, the experimental tool Ptrcheck can detect errors like - this. Run Valgrind with the option - to try it, but beware that it is not as robust as Memcheck. + However, the experimental tool SGcheck can detect errors like + this. Run Valgrind with the option + to try it, but be aware that it is not as robust as Memcheck. diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml index d1fa3e27fd..c2d67e4ba9 100644 --- a/docs/xml/manual-core.xml +++ b/docs/xml/manual-core.xml @@ -899,7 +899,7 @@ 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 and Ptrcheck. The output format + option works with Memcheck, Helgrind and SGcheck. 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 3efbdeea94..79351ba18b 100644 --- a/docs/xml/manual-intro.xml +++ b/docs/xml/manual-intro.xml @@ -60,10 +60,10 @@ and without disturbing the existing structure. - Ptrcheck is an experimental heap, stack and - global array overrun detector. Its functionality overlaps somewhat - with Memcheck's, but it can find some problems that Memcheck would - miss. + 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.. diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml index 04918e291c..0d086fffe6 100644 --- a/docs/xml/valgrind-manpage.xml +++ b/docs/xml/valgrind-manpage.xml @@ -189,11 +189,11 @@ system: &vg-docs-path;, or online: - -Ptrcheck Options + +SGcheck Options - -- 2.47.2