source: general/genlib/umockdev.xml@ 45ab6c7

11.0 qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • 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 "e6c06e56873ee7d5fbb9e3efa758edaf">
10 <!ENTITY umockdev-size "448 KB">
11 <!ENTITY umockdev-buildsize "7.3 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 &lfs101_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"/> and
78 <xref linkend="vala"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="gtk-doc"/> and
84 <ulink url="http://www.gphoto.org/">libgphoto2</ulink> (optional for tests)
85 </para>
86
87 <para condition="html" role="usernotes">
88 User Notes: <ulink url="&blfs-wiki;/umockdev"/>
89 </para>
90 </sect2>
91
92 <sect2 role="installation">
93 <title>Installation of Umockdev</title>
94
95 <para>
96 Install <application>Umockdev</application> by running the following
97 commands:
98 </para>
99
100<screen><userinput>mkdir build &amp;&amp;
101cd build &amp;&amp;
102
103meson --prefix=/usr .. &amp;&amp;
104ninja</userinput></screen>
105
106 <para>
107 To test the results, issue: <command>PATH=$PATH:/sbin:/usr/sbin ninja
108 test</command>. The addition to <envar>PATH</envar> is needed if you
109 use the starting scripts in <xref linkend="postlfs-config-profile"/>,
110 because some tests need to run <command>udevadm</command>. One test
111 needs to be run in an X session.
112 </para>
113
114 <para>
115 Now, as the <systemitem class="username">root</systemitem> user:
116 </para>
117
118<screen role="root"><userinput>ninja install</userinput></screen>
119 </sect2>
120
121 <sect2 role="commands">
122 <title>Command Explanations</title>
123
124<!--
125 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
126 href="../../xincludes/static-libraries.xml"/>
127
128 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
129 href="../../xincludes/gtk-doc-rebuild.xml"/>
130-->
131 <para>
132 <option>-Dgtk_doc=true</option>: Use this switch if you have
133 <xref linkend="gtk-doc" role="nodep"/> installed and wish to rebuild and
134 install the API documentation.
135 </para>
136
137 </sect2>
138
139 <sect2 role="content">
140 <title>Contents</title>
141
142 <segmentedlist>
143 <segtitle>Installed Programs</segtitle>
144 <segtitle>Installed Libraries</segtitle>
145 <segtitle>Installed Directories</segtitle>
146
147 <seglistitem>
148 <seg>
149 umockdev-record,
150 umockdev-run, and
151 umockdev-wrapper
152 </seg>
153 <seg>
154 libumockdev-preload.so.0 <!-- Only intended for use by
155 umockdev-wrapper. Don't put in a short description for this--> and
156 libumockdev.so
157 </seg>
158 <seg>
159 /usr/include/umockdev-1.0
160 </seg>
161 </seglistitem>
162 </segmentedlist>
163
164 <variablelist>
165 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
166 <?dbfo list-presentation="list"?>
167 <?dbhtml list-presentation="table"?>
168
169 <varlistentry id="umockdev-record">
170 <term><command>umockdev-record</command></term>
171 <listitem>
172 <para>
173 records Linux devices and their ancestors from sysfs/udev or
174 records ioctls for a device
175 </para>
176 <indexterm zone="umockdev umockdev-record">
177 <primary sortas="b-umockdev-record">umockdev-record</primary>
178 </indexterm>
179 </listitem>
180 </varlistentry>
181
182 <varlistentry id="umockdev-run">
183 <term><command>umockdev-run</command></term>
184 <listitem>
185 <para>
186 runs a program under an <application>umockdev</application>
187 testbed
188 </para>
189 <indexterm zone="umockdev umockdev-run">
190 <primary sortas="b-umockdev-run">umockdev-run</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="umockdev-wrapper">
196 <term><command>umockdev-wrapper</command></term>
197 <listitem>
198 <para>
199 wraps a program around
200 <filename class="libraryfile">libumockdev-preload.so.0</filename>
201 through LD_PRELOAD
202 </para>
203 <indexterm zone="umockdev umockdev-wrapper">
204 <primary sortas="b-umockdev-wrapper">umockdev-wrapper</primary>
205 </indexterm>
206 </listitem>
207 </varlistentry>
208
209 <varlistentry id="libumockdev">
210 <term><filename class="libraryfile">libumockdev.so</filename></term>
211 <listitem>
212 <para>
213 provides API functions that allow mocking hardware devices for unit
214 testing
215 </para>
216 <indexterm zone="umockdev libumockdev">
217 <primary sortas="c-libumockdev">libumockdev.so</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221 </variablelist>
222 </sect2>
223
224</sect1>
Note: See TracBrowser for help on using the repository browser.