[e4123d2] | 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 |
|
---|
[c873caa] | 7 | <!ENTITY check-download-http "https://github.com/libcheck/check/releases/download/&check-version;/check-&check-version;.tar.gz">
|
---|
[e4123d2] | 8 | <!ENTITY check-download-ftp " ">
|
---|
[0a95cfcf] | 9 | <!ENTITY check-md5sum "31b17c6075820a434119592941186f70">
|
---|
| 10 | <!ENTITY check-size "748 KB">
|
---|
| 11 | <!ENTITY check-buildsize "9.7 MB (add 1.2 MB for the tests)">
|
---|
| 12 | <!ENTITY check-time "0.1 SBU (add 3.6 SBU for the tests)">
|
---|
[e4123d2] | 13 | ]>
|
---|
| 14 |
|
---|
[07dd360] | 15 | <sect1 id="check" xreflabel="Check-&check-version;">
|
---|
[e4123d2] | 16 | <?dbhtml filename="check.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
[4949485e] | 19 | <date>$Date$</date>
|
---|
[e4123d2] | 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>Check-&check-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="check">
|
---|
[07dd360] | 25 | <primary sortas="a-Check">Check</primary>
|
---|
[e4123d2] | 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to Check</title>
|
---|
| 30 |
|
---|
[07dd360] | 31 | <para>
|
---|
| 32 | <application>Check</application> is a unit testing framework for C.
|
---|
[6fcb1b9] | 33 | It was installed by LFS in the temporary /tools directory. These
|
---|
[07dd360] | 34 | instructions install it permanently.
|
---|
| 35 | </para>
|
---|
[e4123d2] | 36 |
|
---|
[410d9d0] | 37 | &lfs81_checked;
|
---|
[e4123d2] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
[07dd360] | 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&check-download-http;"/>
|
---|
| 44 | </para>
|
---|
[e4123d2] | 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
[07dd360] | 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&check-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
[e4123d2] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[07dd360] | 52 | <para>
|
---|
| 53 | Download MD5 sum: &check-md5sum;
|
---|
| 54 | </para>
|
---|
[e4123d2] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[07dd360] | 57 | <para>
|
---|
| 58 | Download size: &check-size;
|
---|
| 59 | </para>
|
---|
[e4123d2] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[07dd360] | 62 | <para>
|
---|
| 63 | Estimated disk space required: &check-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &check-time;
|
---|
| 69 | </para>
|
---|
[e4123d2] | 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <para condition="html" role="usernotes">User Notes:
|
---|
[07dd360] | 74 | <ulink url="&blfs-wiki;/check"/>
|
---|
| 75 | </para>
|
---|
[e4123d2] | 76 | </sect2>
|
---|
| 77 |
|
---|
| 78 | <sect2 role="installation">
|
---|
| 79 | <title>Installation of Check</title>
|
---|
| 80 |
|
---|
[07dd360] | 81 | <para>
|
---|
| 82 | Install <application>Check</application> by running the following
|
---|
| 83 | commands:
|
---|
| 84 | </para>
|
---|
[e4123d2] | 85 |
|
---|
[07dd360] | 86 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[e4123d2] | 87 | make</userinput></screen>
|
---|
| 88 |
|
---|
[410d9d0] | 89 | <!-- Under LFS 8.1-rc2, the tests do not cause segfaults any longer. -->
|
---|
[07dd360] | 90 | <para>
|
---|
[5f1ca9f] | 91 | To test the installation, issue <command>make check</command>.
|
---|
[410d9d0] | 92 | <!-- Several tests cause segmentation faults that are harmless and can be
|
---|
| 93 | ignored. -->
|
---|
[07dd360] | 94 | </para>
|
---|
[e4123d2] | 95 |
|
---|
[07dd360] | 96 | <para>
|
---|
| 97 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 98 | </para>
|
---|
[e4123d2] | 99 |
|
---|
[24f2d4b] | 100 | <screen role="root"><userinput>make docdir=/usr/share/doc/check-&check-version; install</userinput></screen>
|
---|
[e4123d2] | 101 |
|
---|
| 102 | </sect2>
|
---|
| 103 |
|
---|
[07dd360] | 104 | <sect2 role="commands">
|
---|
| 105 | <title>Command Explanations</title>
|
---|
| 106 |
|
---|
| 107 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 108 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 109 |
|
---|
| 110 | </sect2>
|
---|
| 111 |
|
---|
[e4123d2] | 112 | <sect2 role="content">
|
---|
| 113 | <title>Contents</title>
|
---|
| 114 |
|
---|
| 115 | <segmentedlist>
|
---|
[07dd360] | 116 | <segtitle>Installed Program</segtitle>
|
---|
| 117 | <segtitle>Installed Library</segtitle>
|
---|
| 118 | <segtitle>Installed Directory</segtitle>
|
---|
[e4123d2] | 119 |
|
---|
| 120 | <seglistitem>
|
---|
[07dd360] | 121 | <seg>
|
---|
| 122 | checkmk
|
---|
| 123 | </seg>
|
---|
| 124 | <seg>
|
---|
| 125 | libcheck.so
|
---|
| 126 | </seg>
|
---|
| 127 | <seg>
|
---|
| 128 | /usr/share/doc/check-&check-version;
|
---|
| 129 | </seg>
|
---|
[e4123d2] | 130 | </seglistitem>
|
---|
| 131 | </segmentedlist>
|
---|
| 132 |
|
---|
| 133 | <variablelist>
|
---|
| 134 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 135 | <?dbfo list-presentation="list"?>
|
---|
| 136 | <?dbhtml list-presentation="table"?>
|
---|
| 137 |
|
---|
[07dd360] | 138 | <varlistentry id="checkmk">
|
---|
| 139 | <term><command>checkmk</command></term>
|
---|
| 140 | <listitem>
|
---|
| 141 | <para>
|
---|
| 142 | is an <application>Awk</application> script used for
|
---|
| 143 | generating C unit tests for use with the
|
---|
| 144 | <application>Check</application> unit testing framework.
|
---|
| 145 | </para>
|
---|
| 146 | <indexterm zone="check checkmk">
|
---|
| 147 | <primary sortas="b-checkmk">checkmk</primary>
|
---|
| 148 | </indexterm>
|
---|
| 149 | </listitem>
|
---|
| 150 | </varlistentry>
|
---|
| 151 |
|
---|
[e4123d2] | 152 | <varlistentry id="libcheck">
|
---|
[07dd360] | 153 | <term><filename class="libraryfile">libcheck.so</filename></term>
|
---|
[e4123d2] | 154 | <listitem>
|
---|
[07dd360] | 155 | <para>
|
---|
| 156 | contains the <application>Check</application> API functions.
|
---|
| 157 | </para>
|
---|
[e4123d2] | 158 | <indexterm zone="check libcheck">
|
---|
[07dd360] | 159 | <primary sortas="c-libcheck">libcheck.so</primary>
|
---|
[e4123d2] | 160 | </indexterm>
|
---|
| 161 | </listitem>
|
---|
| 162 | </varlistentry>
|
---|
| 163 |
|
---|
| 164 | </variablelist>
|
---|
| 165 |
|
---|
| 166 | </sect2>
|
---|
| 167 |
|
---|
| 168 | </sect1>
|
---|