Nicholas Nethercote 7a75a9f583 Overhauled the docs. Removed all the HTML files, put in XML files as
converted by Donna.  Hooked it into the build system so they are only
built when specifically asked for, and when doing "make dist".

They're not perfect;  in particular, there are the following problems:
- The plain-text FAQ should be built from FAQ.xml, but this is not
  currently done.  (The text FAQ has been left in for now.)

- The PS/PDF building doesn't work -- it fails with an incomprehensible
  error message which I haven't yet deciphered.

Nonetheless, I'm putting it in so others can see it.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@3153
2004-11-30 10:43:45 +00:00

51 lines
1.4 KiB
XML

<?xml version="1.0"?> <!-- -*- sgml -*- -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="cc-manual" xreflabel="CoreCheck">
<title>CoreCheck: a very simple error detector</title>
<para>CoreCheck is a very simple tool for Valgrind. It adds no
instrumentation to the program's code, and only reports the few
kinds of errors detected by Valgrind's core. It is mainly of use
for Valgrind's developers for debugging and regression
testing.</para>
<para>The errors detected are those found by the core when
<computeroutput>VG_(needs).core_errors</computeroutput> is set.
These include:</para>
<itemizedlist>
<listitem>
<para>Pthread API errors (many; eg. unlocking a non-locked
mutex)</para>
</listitem>
<listitem>
<para>Silly arguments to <computeroutput>malloc() </computeroutput> et al
(eg. negative size)</para>
</listitem>
<listitem>
<para>Invalid file descriptors to blocking syscalls
<computeroutput>read()</computeroutput> and
<computeroutput>write()</computeroutput></para>
</listitem>
<listitem>
<para>Bad signal numbers passed to
<computeroutput>sigaction()</computeroutput></para>
</listitem>
<listitem>
<para>Attempts to install signal handler for
<computeroutput>SIGKILL</computeroutput> or
<computeroutput>SIGSTOP</computeroutput></para>
</listitem>
</itemizedlist>
</chapter>