BOOK/chapter06/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-tools-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-tools-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-ch5-sbu;</seg>
  34         <seg>&check-ch5-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</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 and fix a script:</para>
  60
  61     <screen><userinput remap="install">make docdir=/usr/share/doc/check-&check-version; install &amp;&amp;
  62 sed -i '1 s/tools/usr/' /usr/bin/checkmk</userinput></screen>
  63 <!-- Removes a hardcoded call to /tools/bin/gawk at line 1 of checkmk. -->
  64
  65   </sect2>
  66
  67   <sect2 id="contents-check" role="content">
  68     <title>Contents of Check</title>
  69
  70     <segmentedlist>
  71       <segtitle>Installed program</segtitle>
  72       <segtitle>Installed library</segtitle>
  73
  74       <seglistitem>
  75         <seg>checkmk</seg>
  76         <seg>libcheck.{a,so}</seg>
  77       </seglistitem>
  78     </segmentedlist>
  79
  80     <variablelist>
  81       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  82       <?dbfo list-presentation="list"?>
  83       <?dbhtml list-presentation="table"?>
  84
  85       <varlistentry id="checkmk">
  86         <term><command>checkmk</command></term>
  87         <listitem>
  88           <para>Awk script for generating C unit tests for use with the Check
  89           unit testing framework</para>
  90           <indexterm zone="ch-tools-check checkmk">
  91             <primary sortas="b-checmk">checkmk</primary>
  92           </indexterm>
  93         </listitem>
  94       </varlistentry>
  95
  96       <varlistentry id="libcheck">
  97         <term><filename class="libraryfile">libcheck.{a,so}</filename></term>
  98         <listitem>
  99           <para>Contains functions that allow Check to be called from a test
 100           program</para>
 101           <indexterm zone="ch-tools-check libcheck">
 102             <primary sortas="c-libcheck">libcheck</primary>
 103           </indexterm>
 104         </listitem>
 105       </varlistentry>
 106
 107     </variablelist>
 108
 109   </sect2>
 110
 111 </sect1>