BOOK/chapter08/check.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-check" role="wrap">
   9   <?dbhtml filename="check.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>check</productname>
  13     <productnumber>&check-version;</productnumber>
  14     <address>&check-url;</address>
  15   </sect1info>
  16
  17   <title>Check-&check-version;</title>
  18
  19   <indexterm zone="ch-system-check">
  20     <primary sortas="a-Check">Check</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>Check is a unit testing framework for C.</para>
  27
  28     <segmentedlist>
  29       <segtitle>&buildtime;</segtitle>
  30       <segtitle>&diskspace;</segtitle>
  31
  32       <seglistitem>
  33         <seg>&check-fin-sbu;</seg>
  34         <seg>&check-fin-du;</seg>
  35       </seglistitem>
  36     </segmentedlist>
  37
  38   </sect2>
  39
  40   <sect2 role="installation">
  41     <title>Installation of Check</title>
  42
  43     <para>Prepare Check for compilation:</para>
  44
  45 <screen><userinput remap="configure">./configure --prefix=/usr --disable-static</userinput></screen>
  46
  47     <para>Build the package:</para>
  48
  49 <screen><userinput remap="make">make</userinput></screen>
  50
  51     <para>Compilation is now complete.  To run the Check test suite, issue the
  52     following command:</para>
  53
  54 <screen><userinput remap="test">make check</userinput></screen>
  55
  56     <para>Note that the Check test suite may take a relatively long
  57     (up to 4 SBU) time.</para>
  58
  59     <para>Install the package:</para>
  60
  61     <screen><userinput remap="install">make docdir=/usr/share/doc/check-&check-version; install</userinput></screen>
  62
  63   </sect2>
  64
  65   <sect2 id="contents-check" role="content">
  66     <title>Contents of Check</title>
  67
  68     <segmentedlist>
  69       <segtitle>Installed program</segtitle>
  70       <segtitle>Installed library</segtitle>
  71
  72       <seglistitem>
  73         <seg>checkmk</seg>
  74         <seg>libcheck.so</seg>
  75       </seglistitem>
  76     </segmentedlist>
  77
  78     <variablelist>
  79       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  80       <?dbfo list-presentation="list"?>
  81       <?dbhtml list-presentation="table"?>
  82
  83       <varlistentry id="checkmk">
  84         <term><command>checkmk</command></term>
  85         <listitem>
  86           <para>Awk script for generating C unit tests for use with the Check
  87           unit testing framework</para>
  88           <indexterm zone="ch-system-check checkmk">
  89             <primary sortas="b-checmk">checkmk</primary>
  90           </indexterm>
  91         </listitem>
  92       </varlistentry>
  93
  94       <varlistentry id="libcheck">
  95         <term><filename class="libraryfile">libcheck.{a,so}</filename></term>
  96         <listitem>
  97           <para>Contains functions that allow Check to be called from a test
  98           program</para>
  99           <indexterm zone="ch-system-check libcheck">
 100             <primary sortas="c-libcheck">libcheck</primary>
 101           </indexterm>
 102         </listitem>
 103       </varlistentry>
 104
 105     </variablelist>
 106
 107   </sect2>
 108
 109 </sect1>