source: BOOK/testsuite-tools/common/check.xml@ 3b40ca6

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-testsuite-tools-check" role="wrap">
  <?dbhtml filename="check.html"?>

  <title>Check-&check-version;</title>

  <indexterm zone="ch-testsuite-tools-check">
    <primary sortas="a-Check">Check</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Check package is a unit testing framework for C.</para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Check</title>

    <para os="c">Prepare Check for compilation:</para>

<screen os="d"><userinput>./configure --prefix=/tools</userinput></screen>

    <para os="f">Build the package:</para>

<screen os="g"><userinput>make</userinput></screen>

    <para os="i">Install the package:</para>

<screen os="j"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 id="contents-check" role="content">
    <title>Contents of Check</title>

    <segmentedlist>
      <segtitle>Installed program</segtitle>
      <segtitle>Installed library</segtitle>

      <seglistitem>
        <seg>checkmk</seg>
        <seg>libcheck.{a,so}</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="checkmk">
        <term><command>checkmk</command></term>
        <listitem>
          <para>Awk script for generating C unit tests for use with the C the
          Check unit testing framework</para>
          <indexterm zone="ch-testsuite-tools-check checkmk">
            <primary sortas="b-check">checkmk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcheck">
        <term><filename class="libraryfile">libcheck.{a,so}</filename></term>
        <listitem>
          <para>Contains functions that allow Check to be called from a test
          program</para>
          <indexterm zone="ch-testsuite-tools-check libcheck">
            <primary sortas="c-libcheck">libcheck.{a,so};</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>