]> git.ipfire.org Git - thirdparty/valgrind.git/commitdiff
Remove references to Ptrcheck in the documentation, and replace
authorJulian Seward <jseward@acm.org>
Sun, 26 Jun 2011 19:57:26 +0000 (19:57 +0000)
committerJulian Seward <jseward@acm.org>
Sun, 26 Jun 2011 19:57:26 +0000 (19:57 +0000)
them as relevant with references to SGcheck.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@11839

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

index 7db5d152ae92a344adf6a2e0c70344245b4a3d13..c02720730b1408d59f23da00c4135e7e4fa5cafd 100644 (file)
@@ -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:
      </status>
 
 * 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 <text>...</text> component):
 * <dir>TEXT</dir>, 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 <auxwhat> 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.
-
 
 ====================================================================
 
index af197f856c6dafc74b52f36152e6d62a2502a10b..e0e190bbcbcd4065cbf96eb575077f19941bb9f2 100644 (file)
@@ -467,13 +467,13 @@ int main(void)
 </programlisting>
   </question>
   <answer id="a-overruns">
-    <para>Unfortunately, Memcheck doesn't do bounds checking on static
+    <para>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.</para>
     
-    <para>However, the experimental tool Ptrcheck can detect errors like
-    this.  Run Valgrind with the <option>--tool=exp-ptrcheck</option> option
-    to try it, but beware that it is not as robust as Memcheck.</para>
+    <para>However, the experimental tool SGcheck can detect errors like
+    this.  Run Valgrind with the <option>--tool=exp-sgcheck</option> option
+    to try it, but be aware that it is not as robust as Memcheck.</para>
   </answer>
 </qandaentry>
 
index d1fa3e27fdc59740dba3dcf7fda2903aeaf51048..c2d67e4ba92f9c2217a1295f4cadc63a15f1c6e4 100644 (file)
@@ -899,7 +899,7 @@ 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 and Ptrcheck.  The output format
+      option works with Memcheck, Helgrind and SGcheck.  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 3efbdeea94d24e6fecc19211fb814fc8c83ca515..79351ba18b8126c58c5494225b1f68151b7bba85 100644 (file)
@@ -60,10 +60,10 @@ and without disturbing the existing structure.</para>
   </listitem>
 
   <listitem>
-    <para><command>Ptrcheck</command> 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.</para>
+    <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>
index 04918e291c7d73ccedeef088775d44eaba39e73f..0d086fffe614d08cd143656682ba180bf4852c70 100644 (file)
@@ -189,11 +189,11 @@ system: <filename>&vg-docs-path;</filename>, or online:
 
 
 
-<refsect1 id="ptrcheck-options">
-<title>Ptrcheck Options</title>
+<refsect1 id="sgcheck-options">
+<title>SGcheck Options</title>
 
-<xi:include href="../../exp-ptrcheck/docs/pc-manual.xml" 
-            xpointer="pc.opts.list"
+<xi:include href="../../exp-sgcheck/docs/sg-manual.xml" 
+            xpointer="sg.opts.list"
             xmlns:xi="http://www.w3.org/2001/XInclude" />
 
 </refsect1>