[7152faa] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[ee321a46] | 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 |
|
---|
[afcfd74] | 8 | <sect1 id="ch-system-check" role="wrap">
|
---|
[ee321a46] | 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 |
|
---|
[afcfd74] | 19 | <indexterm zone="ch-system-check">
|
---|
[ee321a46] | 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>
|
---|
[fb386e0] | 33 | <seg>&check-fin-sbu;</seg>
|
---|
| 34 | <seg>&check-fin-du;</seg>
|
---|
[ee321a46] | 35 | </seglistitem>
|
---|
| 36 | </segmentedlist>
|
---|
| 37 |
|
---|
| 38 | </sect2>
|
---|
| 39 |
|
---|
| 40 | <sect2 role="installation">
|
---|
| 41 | <title>Installation of Check</title>
|
---|
| 42 |
|
---|
[95efac6] | 43 | &update-config-text;
|
---|
| 44 |
|
---|
| 45 | <screen><userinput remap="pre">tar &update-config-arg;</userinput></screen>
|
---|
| 46 |
|
---|
[ee321a46] | 47 | <para>Prepare Check for compilation:</para>
|
---|
| 48 |
|
---|
[fe2a824] | 49 | <screen><userinput remap="configure">./configure --prefix=/usr --disable-static</userinput></screen>
|
---|
[ee321a46] | 50 |
|
---|
| 51 | <para>Build the package:</para>
|
---|
| 52 |
|
---|
| 53 | <screen><userinput remap="make">make</userinput></screen>
|
---|
| 54 |
|
---|
[a6fccf3] | 55 | <para>Compilation is now complete. To run the Check test suite, issue the
|
---|
| 56 | following command:</para>
|
---|
[ee321a46] | 57 |
|
---|
| 58 | <screen><userinput remap="test">make check</userinput></screen>
|
---|
| 59 |
|
---|
[c2d2342] | 60 | <!-- <para>Note that the Check test suite may take a relatively long
|
---|
[ee321a46] | 61 | (up to 4 SBU) time.</para>
|
---|
[c2d2342] | 62 | -->
|
---|
[efcb393] | 63 | <para>Install the package:</para>
|
---|
[ee321a46] | 64 |
|
---|
[efcb393] | 65 | <screen><userinput remap="install">make docdir=/usr/share/doc/check-&check-version; install</userinput></screen>
|
---|
[ee321a46] | 66 |
|
---|
| 67 | </sect2>
|
---|
| 68 |
|
---|
| 69 | <sect2 id="contents-check" role="content">
|
---|
| 70 | <title>Contents of Check</title>
|
---|
| 71 |
|
---|
| 72 | <segmentedlist>
|
---|
[1b89678] | 73 | <segtitle>Installed program</segtitle>
|
---|
[ee321a46] | 74 | <segtitle>Installed library</segtitle>
|
---|
| 75 |
|
---|
| 76 | <seglistitem>
|
---|
[1b89678] | 77 | <seg>checkmk</seg>
|
---|
[fe2a824] | 78 | <seg>libcheck.so</seg>
|
---|
[ee321a46] | 79 | </seglistitem>
|
---|
| 80 | </segmentedlist>
|
---|
| 81 |
|
---|
| 82 | <variablelist>
|
---|
| 83 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 84 | <?dbfo list-presentation="list"?>
|
---|
| 85 | <?dbhtml list-presentation="table"?>
|
---|
| 86 |
|
---|
[1b89678] | 87 | <varlistentry id="checkmk">
|
---|
| 88 | <term><command>checkmk</command></term>
|
---|
| 89 | <listitem>
|
---|
| 90 | <para>Awk script for generating C unit tests for use with the Check
|
---|
| 91 | unit testing framework</para>
|
---|
[afcfd74] | 92 | <indexterm zone="ch-system-check checkmk">
|
---|
[1b89678] | 93 | <primary sortas="b-checmk">checkmk</primary>
|
---|
| 94 | </indexterm>
|
---|
| 95 | </listitem>
|
---|
| 96 | </varlistentry>
|
---|
| 97 |
|
---|
[ee321a46] | 98 | <varlistentry id="libcheck">
|
---|
[0ab908d] | 99 | <term><filename class="libraryfile">libcheck.so</filename></term>
|
---|
[ee321a46] | 100 | <listitem>
|
---|
| 101 | <para>Contains functions that allow Check to be called from a test
|
---|
| 102 | program</para>
|
---|
[afcfd74] | 103 | <indexterm zone="ch-system-check libcheck">
|
---|
[ee321a46] | 104 | <primary sortas="c-libcheck">libcheck</primary>
|
---|
| 105 | </indexterm>
|
---|
| 106 | </listitem>
|
---|
| 107 | </varlistentry>
|
---|
| 108 |
|
---|
| 109 | </variablelist>
|
---|
| 110 |
|
---|
| 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | </sect1>
|
---|