glfs/general/prog/check.xml

<?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;

  <!ENTITY check-download-http "&sourceforge-repo2;/projects/check/files/check/&check-version;/check-&check-version;.tar.gz">
  <!ENTITY check-download-ftp  " ">
  <!ENTITY check-md5sum        "5d75e9a6027cde79d2c339ef261e7470">
  <!ENTITY check-size          "552 KB">
  <!ENTITY check-buildsize     "6.5 MB">
  <!ENTITY check-time          "3.4 SBU (including about 3 SBU for the test suite)">
]>

<sect1 id="check" xreflabel="check-&check-version;">
  <?dbhtml filename="check.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

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

  <indexterm zone="check">
    <primary sortas="a-check">check</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Check</title>

    <para><application>Check</application> is a unit testing framework for C.
    It was installed by LFS in the temprary /tools directory.  These
    instructions install it permanently.</para>

    &lfs71_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&check-download-http;"/></para>
      </listitem>
      <!--<listitem>
        <para>Download (FTP): <ulink url="&check-download-ftp;"/></para>
      </listitem>-->
      <listitem>
        <para>Download MD5 sum: &check-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &check-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &check-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &check-time;</para>
      </listitem>
    </itemizedlist>

    <!--
    <bridgehead renderas="sect3">Check Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="???"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="???"/></para>
    -->

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/check"/></para>

  </sect2>

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

    <para>Install <application>Check</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>To test the installation, issue <userinput>make check</userinput>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make docdir=/usr/share/doc/check-&check-version; install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

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

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

      <varlistentry id="libcheck">
        <term><filename class='libraryfile'>libcheck.{so,a}</filename></term>
        <listitem>
          <para>contains the <application>Check</application> API functions.</para>
          <indexterm zone="check libcheck">
            <primary sortas="c-libcheck">libcheck.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>