source: general/genlib/glib2.xml@ ddd5a70

10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since ddd5a70 was ddd5a70, checked in by Pierre Labastie <pieere@…>, 4 years ago

Patch gtk-doc and glib2 to prevent glib2 from downloading a develoment
version of gtk-doc when building the docs

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23740 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 16.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 glib2-download-http "&gnome-download-http;/glib/&glib2-minor;/glib-&glib2-version;.tar.xz">
8 <!ENTITY glib2-download-ftp "&gnome-download-ftp;/glib/&glib2-minor;/glib-&glib2-version;.tar.xz">
9 <!ENTITY glib2-md5sum "5fbccd13eba61294a3e6ba01bb2f9b83">
10 <!ENTITY glib2-size "4.6 MB">
11 <!ENTITY glib2-buildsize "205 MB (add 5 MB for tests)">
12 <!ENTITY glib2-time "0.6 SBU (add 0.9 SBU for tests; both using parallelism=4)">
13]>
14
15<sect1 id="glib2" xreflabel="GLib-&glib2-version;">
16 <?dbhtml filename="glib2.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>GLib-&glib2-version;</title>
24
25 <indexterm zone="glib2">
26 <primary sortas="a-GLib2">GLib2</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to GLib</title>
31
32 <para>
33 The <application>GLib</application> package contains low-level
34 libraries useful for providing data structure handling for C, portability
35 wrappers and interfaces for such runtime functionality as an
36 event loop, threads, dynamic loading and an object system.
37 </para>
38
39 &lfs10_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&glib2-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&glib2-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &glib2-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &glib2-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &glib2-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &glib2-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Optional patch:
80 <ulink url="&patch-root;/glib-&glib2-version;-skip_warnings-1.patch"/>
81 </para>
82 </listitem>
83 </itemizedlist>
84
85 <bridgehead renderas="sect3">GLib Dependencies</bridgehead>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref linkend="libxslt"/> and
90 <xref linkend="pcre"/> (built with Unicode properties)
91 </para>
92
93 <bridgehead renderas="sect4">Optional</bridgehead>
94 <para role="optional">
95 <xref linkend="dbus"/> and
96 <ulink url="https://bindfs.org/">bindfs</ulink>
97 (both may be used in some tests),
98 <xref linkend="gdb"/> (for bindings),
99 <xref linkend="DocBook"/>,
100 <xref linkend="docbook-xsl"/>,
101 <xref linkend="gtk-doc"/> (to build API documentation), and
102 <xref linkend="glib-networking"/> (for some tests, but this is a circular
103 dependency)
104 </para>
105
106 <bridgehead renderas="sect4">Additional Runtime Dependencies</bridgehead>
107 <para role="recommended">
108 <xref role="runtime" linkend="gobject-introspection"/>
109 (should be installed before gtk+, atk, etc.)
110 </para>
111 <para role="optional">
112 Quoted directly from the <filename>INSTALL</filename> file:
113 <quote>Some of the mimetype-related functionality in GIO requires the
114 <command>update-mime-database</command> and
115 <command>update-desktop-database</command> utilities</quote>,
116 which are part of
117 <xref role="runtime" linkend="shared-mime-info"/> and
118 <xref role="runtime" linkend="desktop-file-utils"/>, respectively.
119 These two utilities are also needed for some tests.
120 </para>
121
122 <para condition="html" role="usernotes">User Notes:
123 <ulink url="&blfs-wiki;/glib2"/>
124 </para>
125 </sect2>
126
127 <sect2 role="installation">
128 <title>Installation of GLib</title>
129
130 <para>
131 If desired, apply the optional patch. In many cases, applications that
132 use this library, either directly or indirectly via other libraries such
133 as <xref linkend="gtk3"/>, output numerous warnings when run from the
134 command line. This patch enables the use of an environment variable,
135 <envar>GLIB_LOG_LEVEL</envar>, that supresses unwanted messages. The
136 value of the variable is a digit that corresponds to:
137 </para>
138
139 <simplelist>
140 <member>1 Alert</member>
141 <member>2 Critical</member>
142 <member>3 Error</member>
143 <member>4 Warning</member>
144 <member>5 Notice</member>
145 </simplelist>
146
147 <para>
148 For instance <userinput>export GLIB_LOG_LEVEL=4</userinput> will skip
149 output of Warning and Notice messages (and Info/Debug messages if they
150 are turned on). If <envar>GLIB_LOG_LEVEL</envar> is not defined, normal
151 message output will not be affected.
152 </para>
153
154<screen><userinput>patch -Np1 -i ../glib-&glib2-version;-skip_warnings-1.patch</userinput></screen>
155
156 <warning>
157 <para>
158 If a previous version of glib is installed, move the headers out of the
159 way so that later packages do not encounter conflicts:
160 </para>
161
162<screen><userinput remap="pre">[ -e /usr/include/glib-2.0 ] &amp;&amp; mv -vf /usr/include/glib-2.0{,.old}</userinput></screen>
163
164 </warning>
165
166<!-- Hopefully shouldn't be needed when gtk-doc 1.33 is released -->
167 <para>
168 Prevent the build system from downloading a develoment version of
169 <xref linkend="gtk-doc"/>:
170 </para>
171
172<screen><userinput>sed -i 's/1\.32\.1/1.32/' docs/reference/meson.build</userinput></screen>
173
174 <para>
175 Install <application>GLib</application> by running the following
176 commands:
177 </para>
178
179<screen><userinput>mkdir build &amp;&amp;
180cd build &amp;&amp;
181
182meson --prefix=/usr \
183 -Dman=true \
184 -Dselinux=disabled \
185 .. &amp;&amp;
186ninja</userinput></screen>
187
188 <note><para>
189 If <xref linkend="libxslt"/> is installed, the above command may
190 indicate several (about 33) errors that start with "Error: no ID for
191 constraint linkend:" when gnerating the man pages. These are harmless.
192 </para></note>
193
194 <para>
195 The <application>GLib</application> test suite requires
196 <application>desktop-file-utils</application> for some tests. However,
197 <application>desktop-file-utils</application> requires
198 <application>GLib</application> in order to compile; therefore, you must
199 first install <application>GLib</application> and then run the test
200 suite.
201 </para>
202
203 <para>
204 Now, as the <systemitem class="username">root</systemitem> user:
205 </para>
206
207<screen role="root"><userinput>ninja install &amp;&amp;
208
209mkdir -p /usr/share/doc/glib-&glib2-version; &amp;&amp;
210cp -r ../docs/reference/{NEWS,gio,glib,gobject} /usr/share/doc/glib-&glib2-version;</userinput></screen>
211
212 <para>
213 You should now install <xref linkend="desktop-file-utils"/> and
214 <xref linkend="shared-mime-info"/> and proceed to
215 run the test suite.
216 </para>
217
218 <para>
219 To test the results, after having installed the package, issue:
220 <command>ninja test</command>.
221 <!-- glib issue #1954: -->
222 <!-- One test named gdbus-server-auth sometimes fails.-->
223 <!-- SysV has the symlink now, so gdatetime no longer fails.-->
224 <!-- Needs /etc/localtime to be a symbolic link. In addition
225 the link must be to some place like /usr/share/zoneinfo/...
226
227 This can be overcome if the line below in glib/tests/gdatetime.c
228 is removed or commented out.
229 g_assert_true (*g_time_zone_get_identifier (tz) != '/');
230
231 NOTE: systemd implements this as a hard requirement. -->
232 <!-- with 2.60.4 on systemd, all tests pass. -->
233 <!-- with 2.64.1 on sysV, all tests pass. -->
234 </para>
235
236 </sect2>
237
238 <sect2 role="commands">
239 <title>Command Explanations</title>
240
241 <para>
242 <parameter>-Dman=true</parameter>: This switch causes the
243 build to create and install the package man pages.
244 </para>
245
246 <para>
247 <parameter>-Dselinux=disabled</parameter>: This switch disables
248 support for selinux which is not supported in BLFS.
249 </para>
250
251 <para>
252 <option>-Dgtk_doc=true</option>: This switch causes the
253 build to create and install the API documentation.
254 </para>
255
256 </sect2>
257
258 <sect2 role="content">
259 <title>Contents</title>
260
261 <segmentedlist>
262 <segtitle>Installed Programs</segtitle>
263 <segtitle>Installed Libraries</segtitle>
264 <segtitle>Installed Directories</segtitle>
265
266 <seglistitem>
267 <seg>
268 gapplication, gdbus, gdbus-codegen,
269 gio, gio-querymodules,
270 glib-compile-resources, glib-compile-schemas,
271 glib-genmarshal, glib-gettextize,
272 glib-mkenums, gobject-query,
273 gresource, gsettings,
274 gtester, and gtester-report
275 </seg>
276 <seg>
277 libgio-2.0.so,
278 libglib-2.0.so,
279 libgmodule-2.0.so,
280 libgobject-2.0.so, and
281 libgthread-2.0.so
282 </seg>
283 <seg>
284 /usr/include/gio-unix-2.0,
285 /usr/include/glib-2.0,
286 /usr/lib/glib-2.0,
287 /usr/share/glib-2.0, and
288 /usr/share/gtk-doc/html/{gio,glib,gobject}
289 </seg>
290 </seglistitem>
291 </segmentedlist>
292
293 <variablelist>
294 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
295 <?dbfo list-presentation="list"?>
296 <?dbhtml list-presentation="table"?>
297
298 <varlistentry id="gapplication">
299 <term><command>gapplication</command></term>
300 <listitem>
301 <para>
302 can be used to start applications and to send
303 messages to already-running instances of other applications.
304 </para>
305 <indexterm zone="glib2 gapplication">
306 <primary sortas="b-gapplication">application</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310 <varlistentry id="gdbus">
311 <term><command>gdbus</command></term>
312 <listitem>
313 <para>
314 is a simple tool used for working with
315 <application>D-Bus</application> objects.
316 </para>
317 <indexterm zone="glib2 gdbus">
318 <primary sortas="b-gdbus">gdbus</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="gdbus-codegen">
324 <term><command>gdbus-codegen</command></term>
325 <listitem>
326 <para>
327 is used to generate code and/or documentation for one or
328 more <application>D-Bus</application> interfaces.
329 </para>
330 <indexterm zone="glib2 gdbus-codegen">
331 <primary sortas="b-gdbus-codegen">gdbus-codegen</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="gio">
337 <term><command>gio</command></term>
338 <listitem>
339 <para>
340 is a utility that makes many <application>GIO</application>
341 features available from the command line.
342 </para>
343 <indexterm zone="glib2 gio">
344 <primary sortas="b-gio">gio</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="gio-querymodules">
350 <term><command>gio-querymodules</command></term>
351 <listitem>
352 <para>
353 is used to create a <filename>giomodule.cache</filename> file in
354 the listed directories. This file lists the implemented extension
355 points for each module that has been found.
356 </para>
357 <indexterm zone="glib2 gio-querymodules">
358 <primary sortas="b-gio-querymodules">gio-querymodules</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="glib-compile-resources">
364 <term><command>glib-compile-resources</command></term>
365 <listitem>
366 <para>
367 is used to read the resource description from a file and
368 the files that it references to create a binary resource
369 bundle that is suitable for use with the GResource API.
370 </para>
371 <indexterm zone="glib2 glib-compile-resources">
372 <primary sortas="b-glib-compile-resources">glib-compile-resources</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="glib-compile-schemas">
378 <term><command>glib-compile-schemas</command></term>
379 <listitem>
380 <para>
381 is used to compile all the GSettings XML schema files
382 in a directory into a binary file with the name
383 <filename>gschemas.compiled</filename> that can be used by GSettings.
384 </para>
385 <indexterm zone="glib2 glib-compile-schemas">
386 <primary sortas="b-glib-compile-resources">glib-compile-schemas</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="glib-genmarshal">
392 <term><command>glib-genmarshal</command></term>
393 <listitem>
394 <para>
395 is a C code marshaller generation utility for GLib closures.
396 </para>
397 <indexterm zone="glib2 glib-genmarshal">
398 <primary sortas="b-glib-genmarshal">glib-genmarshal</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="glib-gettextize">
404 <term><command>glib-gettextize</command></term>
405 <listitem>
406 <para>
407 is a variant of the <application>gettext</application>
408 internationalization utility.
409 </para>
410 <indexterm zone="glib2 glib-gettextize">
411 <primary sortas="b-glib-gettextize">glib-gettextize</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="glib-mkenums">
417 <term><command>glib-mkenums</command></term>
418 <listitem>
419 <para>
420 is a C language enum description generation utility.
421 </para>
422 <indexterm zone="glib2 glib-mkenums">
423 <primary sortas="b-glib-mkenums">glib-mkenums</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="gobject-query">
429 <term><command>gobject-query</command></term>
430 <listitem>
431 <para>
432 is a small utility that draws a tree of types.
433 </para>
434 <indexterm zone="glib2 gobject-query">
435 <primary sortas="b-gobject-query">gobject-query</primary>
436 </indexterm>
437 </listitem>
438 </varlistentry>
439
440 <varlistentry id="gresource">
441 <term><command>gresource</command></term>
442 <listitem>
443 <para>
444 offers a simple command line interface to GResource.
445 </para>
446 <indexterm zone="glib2 gresource">
447 <primary sortas="b-gresource">gresource</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="gsettings">
453 <term><command>gsettings</command></term>
454 <listitem>
455 <para>
456 offers a simple command line interface to GSettings.
457 </para>
458 <indexterm zone="glib2 gsettings">
459 <primary sortas="b-gsettings">gsettings</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="gtester">
465 <term><command>gtester</command></term>
466 <listitem>
467 <para>
468 is a test running utility.
469 </para>
470 <indexterm zone="glib2 gtester">
471 <primary sortas="b-gtester">gtester</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="gtester-report">
477 <term><command>gtester-report</command></term>
478 <listitem>
479 <para>
480 is a test report formatting utility.
481 </para>
482 <indexterm zone="glib2 gtester-report">
483 <primary sortas="b-gtester-report">gtester-report</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>
487
488 <varlistentry id="GLib-libraries">
489 <term>GLib libraries</term>
490 <listitem>
491 <para>
492 contain low-level core libraries for the
493 <application>GIMP</application> Toolkit.
494 </para>
495 <indexterm zone="glib2 GLib-libraries">
496 <primary sortas="c-GLib-libraries">Glib libraries</primary>
497 </indexterm>
498 </listitem>
499 </varlistentry>
500
501 </variablelist>
502
503 </sect2>
504
505</sect1>
Note: See TracBrowser for help on using the repository browser.