[ee321a46] | 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 |
|
---|
[2027144] | 45 | <screen><userinput remap="configure">PKG_CONFIG= ./configure --prefix=/tools</userinput></screen>
|
---|
| 46 |
|
---|
| 47 | <variablelist>
|
---|
| 48 | <title>The meaning of the configure parameter:</title>
|
---|
| 49 |
|
---|
| 50 | <varlistentry>
|
---|
| 51 | <term><parameter>PKG_CONFIG=</parameter></term>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>This tells the configure script to ignore any
|
---|
| 54 | pkg-config options that may cause the system to try to link
|
---|
| 55 | with libraries not in the <filename class="directory">/tools</filename>
|
---|
| 56 | directory.</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | </varlistentry>
|
---|
| 59 | </variablelist>
|
---|
[ee321a46] | 60 |
|
---|
| 61 | <para>Build the package:</para>
|
---|
| 62 |
|
---|
| 63 | <screen><userinput remap="make">make</userinput></screen>
|
---|
| 64 |
|
---|
| 65 | <para>Compilation is now complete. As discussed earlier, running the test
|
---|
| 66 | suite is not mandatory for the temporary tools here in this chapter. To run
|
---|
| 67 | the Check test suite anyway, issue the following command:</para>
|
---|
| 68 |
|
---|
| 69 | <screen><userinput remap="test">make check</userinput></screen>
|
---|
| 70 |
|
---|
[2ca8941] | 71 | <para>Note that the Check test suite may take a relatively long
|
---|
[ee321a46] | 72 | (up to 4 SBU) time.</para>
|
---|
| 73 |
|
---|
| 74 | <para>Install the package:</para>
|
---|
| 75 |
|
---|
| 76 | <screen><userinput remap="install">make install</userinput></screen>
|
---|
| 77 |
|
---|
| 78 | </sect2>
|
---|
| 79 |
|
---|
| 80 | <sect2 id="contents-check" role="content">
|
---|
| 81 | <title>Contents of Check</title>
|
---|
| 82 |
|
---|
| 83 | <segmentedlist>
|
---|
[1b89678] | 84 | <segtitle>Installed program</segtitle>
|
---|
[ee321a46] | 85 | <segtitle>Installed library</segtitle>
|
---|
| 86 |
|
---|
| 87 | <seglistitem>
|
---|
[1b89678] | 88 | <seg>checkmk</seg>
|
---|
[ee321a46] | 89 | <seg>libcheck.{a,so}</seg>
|
---|
| 90 | </seglistitem>
|
---|
| 91 | </segmentedlist>
|
---|
| 92 |
|
---|
| 93 | <variablelist>
|
---|
| 94 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 95 | <?dbfo list-presentation="list"?>
|
---|
| 96 | <?dbhtml list-presentation="table"?>
|
---|
| 97 |
|
---|
[1b89678] | 98 | <varlistentry id="checkmk">
|
---|
| 99 | <term><command>checkmk</command></term>
|
---|
| 100 | <listitem>
|
---|
| 101 | <para>Awk script for generating C unit tests for use with the Check
|
---|
| 102 | unit testing framework</para>
|
---|
| 103 | <indexterm zone="ch-tools-check checkmk">
|
---|
| 104 | <primary sortas="b-checmk">checkmk</primary>
|
---|
| 105 | </indexterm>
|
---|
| 106 | </listitem>
|
---|
| 107 | </varlistentry>
|
---|
| 108 |
|
---|
[ee321a46] | 109 | <varlistentry id="libcheck">
|
---|
| 110 | <term><filename class="libraryfile">libcheck.{a,so}</filename></term>
|
---|
| 111 | <listitem>
|
---|
| 112 | <para>Contains functions that allow Check to be called from a test
|
---|
| 113 | program</para>
|
---|
| 114 | <indexterm zone="ch-tools-check libcheck">
|
---|
| 115 | <primary sortas="c-libcheck">libcheck</primary>
|
---|
| 116 | </indexterm>
|
---|
| 117 | </listitem>
|
---|
| 118 | </varlistentry>
|
---|
| 119 |
|
---|
| 120 | </variablelist>
|
---|
| 121 |
|
---|
| 122 | </sect2>
|
---|
| 123 |
|
---|
| 124 | </sect1>
|
---|