|
From: <sv...@va...> - 2005-06-12 10:24:17
|
Author: de Date: 2005-06-12 11:23:23 +0100 (Sun, 12 Jun 2005) New Revision: 3898 Log: mc-tech-docs.xml: - fixed link to comply with house-style mc-manual.xml: - rm'd unhelpful sentence + it's footnote quick-start-guide.xml: - fixed up some section ids + xreflabels=20 so we don't get cool filenames like 'bk01s02.html'. Modified: trunk/docs/xml/quick-start-guide.xml trunk/memcheck/docs/mc-manual.xml trunk/memcheck/docs/mc-tech-docs.xml Modified: trunk/docs/xml/quick-start-guide.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/xml/quick-start-guide.xml 2005-06-12 04:34:51 UTC (rev 389= 7) +++ trunk/docs/xml/quick-start-guide.xml 2005-06-12 10:23:23 UTC (rev 389= 8) @@ -34,14 +34,16 @@ to Valgrind version 2.4.0; some of the information is not quite right f= or earlier versions.</para> =20 -<sect1> +<sect1 id=3D"quick-start.prepare"=20 + xreflabel=3D"Preparing your program"> <title>Preparing your program</title> <para>Compile your program with <computeroutput>-g</computeroutput> to i= nclude debugging information so that Memcheck's error messages include exact li= ne numbers.</para> </sect1> =20 -<sect1> +<sect1 id=3D"quick-start.mcrun"=20 + xreflabel=3D"Running your program under Memcheck"> <title>Running your program under Memcheck</title> <para>If you normally run your program like this: =20 @@ -64,7 +66,8 @@ and leaks that it detects.</para> </sect1> =20 -<sect1> +<sect1 id=3D"quick-start.interpret"=20 + xreflabel=3D"Interpreting Memcheck's output"> <title>Interpreting Memcheck's output</title> <para>Here's an example C program with a memory error and a memory leak. =20 @@ -170,7 +173,7 @@ examples of all the error messages Memcheck produces.</para> </sect1> =20 -<sect1> +<sect1 id=3D"quick-start.caveats" xreflabel=3D"Caveats"> <title>Caveats</title> <para>Memcheck is not perfect; it occasionally produces false positives= , and there are mechanisms for suppressing these (see @@ -184,7 +187,7 @@ allocated statically or on the stack.</para> </sect1> =20 -<sect1> +<sect1 id=3D"quick-start.info" xreflabel=3D"More Information"> <title>More information</title> <para>Please consult the <xref linkend=3D"FAQ"/> and the <xref linkend=3D"manual"/>, which have much more information. Note that= the Modified: trunk/memcheck/docs/mc-manual.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/memcheck/docs/mc-manual.xml 2005-06-12 04:34:51 UTC (rev 3897) +++ trunk/memcheck/docs/mc-manual.xml 2005-06-12 10:23:23 UTC (rev 3898) @@ -396,16 +396,7 @@ before the pointer actually returned. This implies a variable-sized overhead in what's returned by <computeroutput>new</computeroutput> or -<computeroutput>new[]</computeroutput>. It rather surprising how -compilers -<footnote> - <para>[Ed: runtime-support libraries ?]</para> -</footnote> -are robust to mismatch in <computeroutput>new</computeroutput> / -<computeroutput>delete</computeroutput> -<computeroutput>new[]</computeroutput> / -<computeroutput>delete[]</computeroutput>.</para> - +<computeroutput>new[]</computeroutput>. </sect2> =20 =20 Modified: trunk/memcheck/docs/mc-tech-docs.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/memcheck/docs/mc-tech-docs.xml 2005-06-12 04:34:51 UTC (rev 389= 7) +++ trunk/memcheck/docs/mc-tech-docs.xml 2005-06-12 10:23:23 UTC (rev 389= 8) @@ -1534,7 +1534,7 @@ =20 =20 =20 -<sect2 id=3D"mc-manual.trans" xreflabel=3D"Translation into UCode"> +<sect2 id=3D"mc-tech-docs.trans" xreflabel=3D"Translation into UCode"> <title>Translation into UCode</title> =20 <para><computeroutput>VG_(disBB)</computeroutput> allocates a new |