source: gnome/platform/tracker3-miners.xml@ 9612d4f3

12.2 gimp3 lazarus trunk xry111/for-12.3 xry111/spidermonkey128
Last change on this file since 9612d4f3 was 9612d4f3, checked in by Xi Ruoyao <xry111@…>, 2 months ago

tracker-miners: Fix test failures

There are several test failures caused by various issues. Apply two
patches from the upstream to fix 2 failures indicating real function
issues. Some tests expect LC_ALL=C.UTF-8. One test expects debug, so
run the test after installation and reconfiguration with debug enabled
like tracker.

Add a space after -D by the way.
  • Property mode set to 100644
File size: 13.2 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 tracker3-miners-download-http "&gnome-download-http;/tracker-miners/3.7/tracker-miners-&tracker3-miners-version;.tar.xz">
8 <!ENTITY tracker3-miners-download-ftp " ">
9 <!ENTITY tracker3-miners-md5sum "8c1b48f2fa57d888967de9b5ff348fc1">
10 <!ENTITY tracker3-miners-size "4.3 MB">
11 <!ENTITY tracker3-miners-buildsize "36 MB (with tests)">
12 <!ENTITY tracker3-miners-time "0.3 SBU (with parallelism=4; add as much as 1.0 SBU for tests, dependent on disk speed)">
13]>
14
15<sect1 id="tracker3-miners" xreflabel="tracker-miners-&tracker3-miners-version;">
16 <?dbhtml filename="tracker3-miners.html"?>
17
18
19 <title>Tracker-miners-&tracker3-miners-version;</title>
20
21 <indexterm zone="tracker3-miners">
22 <primary sortas="a-tracker3-miners">tracker3-miners</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Tracker-miners</title>
27
28 <para>
29 The <application>Tracker-miners</application> package contains a set of
30 data extractors for Tracker.
31 </para>
32
33 &lfs121_checked;
34
35 <bridgehead renderas="sect3">Package Information</bridgehead>
36 <itemizedlist spacing="compact">
37 <listitem>
38 <para>
39 Download (HTTP): <ulink url="&tracker3-miners-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&tracker3-miners-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &tracker3-miners-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &tracker3-miners-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &tracker3-miners-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &tracker3-miners-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
70 <itemizedlist spacing="compact">
71 <listitem>
72 <para>
73 Required patch:
74 <ulink url="&patch-root;/tracker-miners-&tracker3-miners-version;-upstream_fixes-1.patch"/>
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">Tracker-miners Dependencies</bridgehead>
80
81 <bridgehead renderas="sect4">Required</bridgehead>
82 <para role="required">
83 <xref linkend="gst10-plugins-base"/>,
84 <xref linkend="tracker3"/>,
85 <xref linkend="exempi"/>, and
86 <xref linkend="gexiv2"/>
87 </para>
88
89 <bridgehead renderas="sect4">Recommended</bridgehead>
90 <para role="recommended">
91 <xref linkend="giflib"/>,
92 <xref role='runtime' linkend="gst10-plugins-good"/> (runtime),
93 <xref role='runtime' linkend="gst10-libav"/> (runtime),
94 <xref linkend="icu"/>,
95 <xref linkend="libexif"/>,
96 <xref linkend="libgrss"/>,
97 <xref linkend="libgxps"/>,
98 <xref linkend="libseccomp"/>,
99 <xref linkend="poppler"/>, and
100 <xref linkend="upower"/>
101 </para>
102
103 <bridgehead renderas="sect4">Optional</bridgehead>
104 <para role="optional">
105 <xref linkend="asciidoc"/>,
106 <xref linkend="cmake"/>,
107 <xref linkend="dconf"/>,
108 <xref linkend="ffmpeg"/>,
109 <xref linkend="libgsf"/>,
110 <xref linkend="NetworkManager"/>,
111 <xref linkend="taglib"/>,
112 <xref linkend="totem-pl-parser"/>,
113 <ulink url="https://github.com/lipnitsk/libcue">libcue</ulink>,
114 <ulink url="https://libiptcdata.sourceforge.net/">libitpcdata</ulink>,
115 <ulink url="https://libosinfo.org">libosinfo</ulink>, and
116 <ulink url="https://gitlab.gnome.org/GNOME/gupnp">gupnp</ulink>
117 </para>
118
119 </sect2>
120
121 <sect2 role="kernel" id="tracker3-miners-kernel">
122 <title>Kernel Configuration</title>
123
124 <para>
125 Enable the following options in the kernel configuration, then recompile
126 the kernel and reboot if necessary:
127 </para>
128
129 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
130 href="tracker3-miners-kernel.xml"/>
131
132 <indexterm zone="tracker3-miners tracker3-miners-kernel">
133 <primary sortas="d-traker-miners">tracker-miners</primary>
134 </indexterm>
135 </sect2>
136
137 <sect2 role="installation">
138 <title>Installation of Tracker-miners</title>
139
140 <note>
141 <para>
142 If you plan to run the tests, some timeouts are too short when
143 using spinning disks. There are two places where timeouts are
144 used: first, individual tests inside a group of tests have a
145 default timeout of 10s. This can be changed by setting the environment
146 variable <envar>TRACKER_TESTS_AWAIT_TIMEOUT</envar> to the desired
147 value when running the tests (see below). Second, a global timeout
148 for a group of tests is fixed at configuration time. The default value
149 in the <filename class="directory">functional-tests</filename>
150 directory (other directories have only short lived tests) may be
151 increased with the following command (replace 200 with a value
152 suitable for your machine):
153 </para>
154
155<screen remap="test"><userinput>sed -i s/120/<replaceable>200</replaceable>/ tests/functional-tests/meson.build</userinput></screen>
156 </note>
157
158 <para>
159 First, fix one issue in the TIFF extractor and another issue in the
160 Landlock sandbox:
161 </para>
162
163<screen><userinput remap="pre">patch -Np1 -i ../tracker-miners-&tracker3-miners-version;-upstream_fixes-1.patch</userinput></screen>
164
165 <para>
166 Install <application>Tracker-miners</application> by running the following
167 commands:
168 </para>
169
170
171<screen revision="systemd"><userinput>mkdir build &amp;&amp;
172cd build &amp;&amp;
173
174meson setup --prefix=/usr \
175 --buildtype=release \
176 -D man=false \
177 .. &amp;&amp;
178ninja</userinput></screen>
179
180<screen revision="sysv"><userinput>mkdir build &amp;&amp;
181cd build &amp;&amp;
182
183meson setup --prefix=/usr \
184 --buildtype=release \
185 -D systemd_user_services=false \
186 -D man=false \
187 .. &amp;&amp;
188ninja</userinput></screen>
189
190
191 <para>
192 Now, as the <systemitem class="username">root</systemitem> user:
193 </para>
194
195 <screen role="root"><userinput>ninja install</userinput></screen>
196
197 <para>
198 To test the results, issue (adjust the individual test timeout to a
199 value suitable for your machine, see the note above):
200 </para>
201
202<screen remap="test"><userinput>meson configure -D debug=true &amp;&amp;
203dbus-run-session env LC_ALL=C.UTF-8 TRACKER_TESTS_AWAIT_TIMEOUT=<replaceable>20</replaceable> \
204 ninja test &amp;&amp;
205rm -rf ~/tracker-tests</userinput></screen>
206
207 <note>
208 <para>
209 The tests create files in the user directory (up to 24 MB), so
210 they have to be removed afterwards.
211 </para>
212 </note>
213 </sect2>
214
215 <sect2 role="commands">
216 <title>Command Explanations</title>
217
218 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
219 href="../../xincludes/meson-buildtype-release.xml"/>
220
221 <para>
222 <parameter>-D man=false</parameter>: This switch prevents the build process
223 from generating man pages. Omit this switch if you have
224 <xref linkend="asciidoc" role="nodep"/> installed and wish to generate and
225 install the man pages.
226 </para>
227
228 <para revision="sysv">
229 <parameter>-D systemd_user_services=false</parameter>: This switch prevents
230 the build process from installing systemd units since they are useless
231 on SysV systems.
232 </para>
233
234 <para>
235 <option>-D seccomp=false</option>: This option disables the seccomp system
236 call filter. On some architectures, such as i686 and ARM, the functions
237 that tracker-miners uses are not guarded properly, and tracker-miners
238 will get killed with a SIGSYS as a result. Note that disabling
239 seccomp might cause the system compromised more severely in case a
240 security vulnerability in tracker-miners or its dependencies is
241 exploited.
242 </para>
243
244 <para>
245 <option>-D landlock=disabled</option>: This switch disables the
246 Landlock file access sandbox. Use it if you don't want to build the
247 kernel with Landlock support. Note that disabling Landlock might
248 cause the system compromised more severely in case a security
249 vulnerability in tracker-miners or its dependencies is exploited.
250 </para>
251
252 <para>
253 <option>-D miner_rss=false</option>: Use this option if you have not
254 installed the recommended dependency libgrss.
255 </para>
256
257 <para>
258 <option>-D battery_detection=none</option>: Use this option if you have
259 not installed the recommended dependency upower. Do not use this
260 option if your system has a battery (laptop battery or UPS), or
261 tracker miners may waste the battery power and lifespan when the A/C
262 power is unavailable.
263 </para>
264
265 </sect2>
266
267 <sect2 role="content">
268 <title>Contents</title>
269
270 <segmentedlist>
271 <segtitle>Installed Programs</segtitle>
272 <segtitle>Installed Libraries</segtitle>
273 <segtitle>Installed Directories</segtitle>
274
275 <seglistitem>
276 <seg>
277 tracker3-daemon,
278 tracker3-extract,
279 tracker3-index,
280 tracker3-info,
281 tracker3-reset,
282 tracker3-search,
283 tracker3-status, and
284 tracker3-tag
285 </seg>
286 <seg>
287 Several modules under /usr/lib/tracker-miners-3.0
288 </seg>
289 <seg>
290 /usr/lib/tracker-miners-3.0,
291 /usr/libexec/tracker3, and
292 /usr/share/tracker3-miners
293 </seg>
294 </seglistitem>
295 </segmentedlist>
296
297 <variablelist>
298 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
299 <?dbfo list-presnetation="list"?>
300 <?dbhtml list-presentation="table"?>
301
302 <varlistentry id="tracker3-daemon">
303 <term><command>tracker3-daemon</command></term>
304 <listitem>
305 <para>
306 starts, stops, restarts, and lists daemons responsible for indexing
307 content
308 </para>
309 <indexterm zone="tracker3-miners tracker3-daemon">
310 <primary sortas="b-tracker3-daemon">tracker3-daemon</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="tracker3-extract">
316 <term><command>tracker3-extract</command></term>
317 <listitem>
318 <para>
319 extracts metadata from a file
320 </para>
321 <indexterm zone="tracker3-miners tracker3-extract">
322 <primary sortas="b-tracker3-extract">tracker3-extract</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="tracker3-index">
328 <term><command>tracker3-index</command></term>
329 <listitem>
330 <para>
331 indexes content using the Tracker filesystem miner
332 </para>
333 <indexterm zone="tracker3-miners tracker3-index">
334 <primary sortas="b-tracker3-index">tracker3-index</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="tracker3-info">
340 <term><command>tracker3-info</command></term>
341 <listitem>
342 <para>
343 retrieves all information available for a certain file
344 </para>
345 <indexterm zone="tracker3-miners tracker3-info">
346 <primary sortas="b-tracker3-info">tracker3-info</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="tracker3-reset">
352 <term><command>tracker3-reset</command></term>
353 <listitem>
354 <para>
355 resets the Tracker index and configuration
356 </para>
357 <indexterm zone="tracker3-miners tracker3-reset">
358 <primary sortas="b-tracker3-reset">tracker3-reset</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="tracker3-search">
364 <term><command>tracker3-search</command></term>
365 <listitem>
366 <para>
367 searches for content by type or across all types
368 </para>
369 <indexterm zone="tracker3-miners tracker3-search">
370 <primary sortas="b-tracker3-search">tracker3-search</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="tracker3-status">
376 <term><command>tracker3-status</command></term>
377 <listitem>
378 <para>
379 provides status and statistics on data that has been indexed
380 </para>
381 <indexterm zone="tracker3-miners tracker3-status">
382 <primary sortas="b-tracker3-status">tracker3-status</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="tracker3-tag">
388 <term><command>tracker3-tag</command></term>
389 <listitem>
390 <para>
391 adds, removes, and lists tags
392 </para>
393 <indexterm zone="tracker3-miners tracker3-tag">
394 <primary sortas="b-tracker3-tag">tracker3-tag</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398 </variablelist>
399 </sect2>
400
401</sect1>
Note: See TracBrowser for help on using the repository browser.