source: general/genlib/umockdev.xml@ 113f4e6

11.1 11.2 lazarus trunk xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 113f4e6 was 113f4e6, checked in by Pierre Labastie <pierre.labastie@…>, 8 months ago

Package updates

gnutls-3.7.3 (security fix)
libical-3.0.13
folks-0.15.4
umockdev-0.17.5

  • Property mode set to 100644
File size: 6.6 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 <!ENTITY umockdev-download-http "https://github.com/martinpitt/umockdev/releases/download/&umockdev-version;/umockdev-&umockdev-version;.tar.xz">
8 <!ENTITY umockdev-download-ftp " ">
9 <!ENTITY umockdev-md5sum "cbf62c1a89123a9c13f9ff6598c8cd09">
10 <!ENTITY umockdev-size "475 KB">
11 <!ENTITY umockdev-buildsize "7.2 MB (with tests)">
12 <!ENTITY umockdev-time "0.2 SBU (with tests)">
13
14]>
15
16<sect1 id="umockdev" xreflabel="umockdev-&umockdev-version;">
17 <?dbhtml filename="umockdev.html"?>
18
19 <sect1info>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Umockdev-&umockdev-version;</title>
24
25 <indexterm zone="umockdev">
26 <primary sortas="a-umockdev">umockdev</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Umockdev</title>
31
32 <para>
33 The <application>Umockdev</application> package contains a framework
34 that allows a developer to mock devices for use in unit testing.
35 </para>
36
37 &lfs110a_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&umockdev-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&umockdev-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &umockdev-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &umockdev-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &umockdev-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &umockdev-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Umockdev Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="libgudev"/>,
78 <xref linkend="libpcap"/>, and
79 <xref linkend="vala"/>
80 </para>
81
82 <bridgehead renderas="sect4">Optional</bridgehead>
83 <para role="optional">
84 <xref linkend="gtk-doc"/> and
85 <ulink url="http://www.gphoto.org/">libgphoto2</ulink> (optional for tests)
86 </para>
87
88 <para condition="html" role="usernotes">
89 User Notes: <ulink url="&blfs-wiki;/umockdev"/>
90 </para>
91 </sect2>
92
93 <sect2 role="installation">
94 <title>Installation of Umockdev</title>
95
96 <para>
97 Install <application>Umockdev</application> by running the following
98 commands:
99 </para>
100
101<screen><userinput>mkdir build &amp;&amp;
102cd build &amp;&amp;
103
104meson --prefix=/usr --buildtype=release .. &amp;&amp;
105ninja</userinput></screen>
106
107 <para>
108 To test the results, issue: <command>PATH=$PATH:/usr/sbin ninja
109 test</command>. The addition to <envar>PATH</envar> is needed if you
110 use the starting scripts in <xref linkend="postlfs-config-profile"/>,
111 because some tests need to run <command>udevadm</command>. One test
112 needs to be run in an X session.
113 </para>
114
115 <para>
116 Now, as the <systemitem class="username">root</systemitem> user:
117 </para>
118
119<screen role="root"><userinput>ninja install</userinput></screen>
120 </sect2>
121
122 <sect2 role="commands">
123 <title>Command Explanations</title>
124
125<!--
126 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
127 href="../../xincludes/static-libraries.xml"/>
128
129 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
130 href="../../xincludes/gtk-doc-rebuild.xml"/>
131-->
132 <para>
133 <option>-Dgtk_doc=true</option>: Use this switch if you have
134 <xref linkend="gtk-doc" role="nodep"/> installed and wish to rebuild and
135 install the API documentation.
136 </para>
137
138 </sect2>
139
140 <sect2 role="content">
141 <title>Contents</title>
142
143 <segmentedlist>
144 <segtitle>Installed Programs</segtitle>
145 <segtitle>Installed Libraries</segtitle>
146 <segtitle>Installed Directories</segtitle>
147
148 <seglistitem>
149 <seg>
150 umockdev-record,
151 umockdev-run, and
152 umockdev-wrapper
153 </seg>
154 <seg>
155 libumockdev-preload.so <!-- Only intended for use by
156 umockdev-wrapper. Don't put in a short description for this--> and
157 libumockdev.so
158 </seg>
159 <seg>
160 /usr/include/umockdev-1.0
161 </seg>
162 </seglistitem>
163 </segmentedlist>
164
165 <variablelist>
166 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
167 <?dbfo list-presentation="list"?>
168 <?dbhtml list-presentation="table"?>
169
170 <varlistentry id="umockdev-record">
171 <term><command>umockdev-record</command></term>
172 <listitem>
173 <para>
174 records Linux devices and their ancestors from sysfs/udev or
175 records ioctls for a device
176 </para>
177 <indexterm zone="umockdev umockdev-record">
178 <primary sortas="b-umockdev-record">umockdev-record</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="umockdev-run">
184 <term><command>umockdev-run</command></term>
185 <listitem>
186 <para>
187 runs a program under an <application>umockdev</application>
188 testbed
189 </para>
190 <indexterm zone="umockdev umockdev-run">
191 <primary sortas="b-umockdev-run">umockdev-run</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195
196 <varlistentry id="umockdev-wrapper">
197 <term><command>umockdev-wrapper</command></term>
198 <listitem>
199 <para>
200 wraps a program around
201 <filename class="libraryfile">libumockdev-preload.so.0</filename>
202 through LD_PRELOAD
203 </para>
204 <indexterm zone="umockdev umockdev-wrapper">
205 <primary sortas="b-umockdev-wrapper">umockdev-wrapper</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="libumockdev">
211 <term><filename class="libraryfile">libumockdev.so</filename></term>
212 <listitem>
213 <para>
214 provides API functions that allow mocking hardware devices for unit
215 testing
216 </para>
217 <indexterm zone="umockdev libumockdev">
218 <primary sortas="c-libumockdev">libumockdev.so</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222 </variablelist>
223 </sect2>
224
225</sect1>
Note: See TracBrowser for help on using the repository browser.