source: BOOK/testsuite-tools/common/check.xml @ 3540f2d

clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 3540f2d was 3540f2d, checked in by William Harrington <kb0iic@…>, 9 years ago

Add check to test suite tools.

  • Property mode set to 100644
File size: 2.3 KB
Line 
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-testsuite-tools-check" role="wrap">
9  <?dbhtml filename="check.html"?>
10
11  <title>Check-&check-version;</title>
12
13  <indexterm zone="ch-testsuite-tools-check">
14    <primary sortas="a-Check">Check</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Check package is a unit testing framework for C.</para>
21
22  </sect2>
23
24  <sect2 role="installation">
25    <title>Installation of Check</title>
26
27    <para os="c">Prepare Check for compilation:</para>
28
29<screen os="d"><userinput>./configure --prefix=/tools</userinput></screen>
30
31    <para os="f">Build the package:</para>
32
33<screen os="g"><userinput>make</userinput></screen>
34
35    <para os="i">Install the package:</para>
36
37<screen os="j"><userinput>make install</userinput></screen>
38
39  </sect2>
40
41  <sect2 id="contents-check" role="content">
42    <title>Contents of Check</title>
43
44    <segmentedlist>
45      <segtitle>Installed program</segtitle>
46      <segtitle>Installed library</segtitle>
47
48      <seglistitem>
49        <seg>checkmk</seg>
50        <seg>libcheck.{a,so}</seg>
51      </seglistitem>
52    </segmentedlist>
53
54    <variablelist>
55      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
56      <?dbfo list-presentation="list"?>
57      <?dbhtml list-presentation="table"?>
58
59      <varlistentry id="checkmk">
60        <term><command>checkmk</command></term>
61        <listitem>
62          <para>Awk script for generating C unit tests for use with the C the
63          Check unit testing framework</para>
64          <indexterm zone="ch-testsuite-tools-check checkmk">
65            <primary sortas="b-check">checkmk</primary>
66          </indexterm>
67        </listitem>
68      </varlistentry>
69
70      <varlistentry id="libcheck">
71        <term><filename class="libraryfile">libcheck.{a,so}</filename></term>
72        <listitem>
73          <para>Contains functions that allow Check to be called from a test
74          program</para>
75          <indexterm zone="ch-testsuite-tools-check libcheck">
76            <primary sortas="c-libcheck">libcheck.{a,so};</primary>
77          </indexterm>
78        </listitem>
79      </varlistentry>
80
81    </variablelist>
82
83  </sect2>
84
85</sect1>
Note: See TracBrowser for help on using the repository browser.