source: general/prog/check.xml@ 6d27308

<?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-repo;/check/check-&check-version;.tar.gz">
  <!ENTITY check-download-ftp  " ">
  <!ENTITY check-md5sum        "53c5e5c77d090e103a17f3ed7fd7d8b8">
  <!ENTITY check-size          "752 KB">
  <!ENTITY check-buildsize     "8.1 MB (additional 0.5 MB for the tests)">
  <!ENTITY check-time          "0.1 SBU (additional 3.7 SBU for the tests)">
]>

<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 temporary /tools directory. These
      instructions install it permanently.
    </para>

    &lfs79_checked;

    &gcc6_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>

    <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 --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      To test the installation, issue <command>make check</command>.
    </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="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          checkmk
        </seg>
        <seg>
          libcheck.so
        </seg>
        <seg>
          /usr/share/doc/check-&check-version;
        </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>
            is an <application>awk</application> script used for
            generating C unit tests for use with the
            <application>Check</application> unit testing framework.
          </para>
          <indexterm zone="check checkmk">
            <primary sortas="b-checkmk">checkmk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>