source: general/genlib/gobject-introspection.xml@ 7a26ad4

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 xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 7a26ad4 was 7a26ad4, checked in by Pierre Labastie <pierre.labastie@…>, 2 years ago

gobject-introspection: upstream patch for meson 0.61
  • Property mode set to 100644
File size: 9.4 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 gobject-introspection-download-http
8 "&gnome-download-http;/gobject-introspection/1.70/gobject-introspection-&gobject-introspection-version;.tar.xz">
9 <!ENTITY gobject-introspection-download-ftp
10 "&gnome-download-ftp;/gobject-introspection/1.70/gobject-introspection-&gobject-introspection-version;.tar.xz">
11 <!ENTITY gobject-introspection-md5sum "940ea2d6b92efabc457b9c54ce2ff398">
12 <!ENTITY gobject-introspection-size "1.0 MB">
13 <!ENTITY gobject-introspection-buildsize "55 MB (with tests)">
14 <!ENTITY gobject-introspection-time "0.2 SBU (With tests; both using parallelism=4)">
15]>
16
17<sect1 id="gobject-introspection" xreflabel="gobject-introspection-&gobject-introspection-version;">
18 <?dbhtml filename="gobject-introspection.html"?>
19
20 <sect1info>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>gobject-introspection-&gobject-introspection-version;</title>
25
26 <indexterm zone="gobject-introspection">
27 <primary sortas="a-gobject-introspection">gobject-introspection</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to GObject Introspection</title>
32
33 <para>
34 The <application>GObject Introspection</application> is used
35 to describe the program APIs and collect them in a uniform,
36 machine readable format.
37 </para>
38
39 &lfs110a_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&gobject-introspection-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&gobject-introspection-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &gobject-introspection-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &gobject-introspection-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &gobject-introspection-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &gobject-introspection-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Required patch for building with meson version 0.61+:
80 <ulink url="&patch-root;/gobject-introspection-&gobject-introspection-version;-build_fix-1.patch"/>
81 </para>
82 </listitem>
83 </itemizedlist>
84
85 <bridgehead renderas="sect3">GObject Introspection Dependencies</bridgehead>
86
87 <bridgehead renderas="sect4">Required</bridgehead>
88 <para role="required">
89 <xref linkend="glib2"/>
90 </para>
91
92 <bridgehead renderas="sect4">Optional</bridgehead>
93 <para role="optional">
94 <xref linkend="cairo"/> (required for the tests),
95 <xref linkend="gjs"/> (to satisfy one test),
96 <xref linkend="gtk-doc"/>,
97 <xref linkend="Mako"/>, and
98 <ulink url="https://pypi.org/project/Markdown/">Markdown</ulink> (to satisfy one test)
99 <!-- There was talk of this being required in the release notes. Can someone
100 who doesn't have this installed verify?
101 It is only needed for one test. bdubbs March 3, 2019
102 -->
103 </para>
104
105 <para condition="html" role="usernotes">User Notes:
106 <ulink url="&blfs-wiki;/gobject-introspection"/>
107 </para>
108 </sect2>
109
110 <sect2 role="installation">
111 <title>Installation of GObject Introspection</title>
112
113 <para>
114 First apply a patch that allows building with meson version 0.61 or
115 above:
116 </para>
117
118<screen><userinput>patch -Np1 -i ../gobject-introspection-&gobject-introspection-version;-build_fix-1.patch</userinput></screen>
119
120 <para>
121 Install <application>GObject Introspection</application> by running
122 the following commands:
123 </para>
124
125<screen><userinput>mkdir build &amp;&amp;
126cd build &amp;&amp;
127
128meson --prefix=/usr --buildtype=release .. &amp;&amp;
129ninja</userinput></screen>
130
131 <para>
132 To test the results, issue: <command>ninja test</command>.
133 If <xref linkend="Mako"/> is installed but the Python 3 module named
134 Markdown (not in BLFS) is not, one test named test_docwriter.py will
135 fail.
136 </para>
137
138 <para>
139 Now, as the <systemitem class="username">root</systemitem> user:
140 </para>
141
142<screen role="root"><userinput>ninja install</userinput></screen>
143
144 </sect2>
145
146 <sect2 role="commands">
147 <title>Command Explanations</title>
148
149 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
150 href="../../xincludes/meson-buildtype-release.xml"/>
151
152 <para>
153 <option>-Dgtk_doc=true</option>: Build and install
154 the documentation.
155 </para>
156
157 <para>
158 <option>-Dcairo=enabled</option>: Use cairo for tests.
159 </para>
160
161 <para>
162 <option>-Ddoctool=enabled</option>: Install g-ir-doc-tool
163 and run related tests.
164 </para>
165
166 </sect2>
167
168 <sect2 role="content">
169 <title>Contents</title>
170
171 <segmentedlist>
172 <segtitle>Installed Program</segtitle>
173 <segtitle>Installed Libraries</segtitle>
174 <segtitle>Installed Directories</segtitle>
175
176 <!-- g-ir-doc-tool is installed if mako is presnet -->
177 <seglistitem>
178 <seg>
179 g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool,
180 g-ir-generate, g-ir-inspect, and g-ir-scanner
181 </seg>
182 <seg>
183 libgirepository-1.0.so and
184 _giscanner.&python3-lib-suffix;.so
185 </seg>
186 <seg>
187 /usr/include/gobject-introspection-1.0,
188 /usr/lib/girepository-1.0,
189 /usr/lib/gobject-introspection,
190 /usr/share/gir-1.0, and
191 /usr/share/gobject-introspection-1.0
192 </seg>
193 </seglistitem>
194 </segmentedlist>
195
196 <variablelist>
197 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
198 <?dbfo list-presentation="list"?>
199 <?dbhtml list-presentation="table"?>
200
201 <varlistentry id="g-ir-annotation-tool">
202 <term><command>g-ir-annotation-tool</command></term>
203 <listitem>
204 <para>
205 creates or extracts annotation data from GI typelibs
206 </para>
207 <indexterm zone="gobject-introspection g-ir-annotation-tool">
208 <primary sortas="b-g-ir-annotation-tool">g-ir-annotation-tool</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="g-ir-compiler">
214 <term><command>g-ir-compiler</command></term>
215 <listitem>
216 <para>
217 converts one or more GIR files into one or more typelib
218 </para>
219 <indexterm zone="gobject-introspection g-ir-compiler">
220 <primary sortas="b-g-ir-compiler">g-ir-compiler</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="g-ir-doc-tool">
226 <term><command>g-ir-doc-tool</command></term>
227 <listitem>
228 <para>
229 generates Mallard files that can be viewed with
230 <command>yelp</command> or rendered to HTML with
231 <command>yelp-build</command> from
232 <ulink url="http://ftp.acc.umu.se/pub/gnome/sources/yelp-tools">yelp-tools</ulink>
233 </para>
234 <indexterm zone="gobject-introspection g-ir-doc-tool">
235 <primary sortas="b-g-ir-doc-tool">g-ir-doc-tool</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="g-ir-inspect">
241 <term><command>g-ir-inspect</command></term>
242 <listitem>
243 <para>
244 is a utility that gives information about a GI typelib
245 </para>
246 <indexterm zone="gobject-introspection g-ir-inspect">
247 <primary sortas="b-g-ir-inspect">g-ir-inspect</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry id="g-ir-generate">
253 <term><command>g-ir-generate</command></term>
254 <listitem>
255 <para>
256 is a GIR generator that uses the repository API
257 </para>
258 <indexterm zone="gobject-introspection g-ir-generate">
259 <primary sortas="b-g-ir-generate">g-ir-generate</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="g-ir-scanner">
265 <term><command>g-ir-scanner</command></term>
266 <listitem>
267 <para>
268 is a tool which generates GIR XML files by parsing headers and
269 introspecting GObject based libraries
270 </para>
271 <indexterm zone="gobject-introspection g-ir-scanner">
272 <primary sortas="b-g-ir-scanner">g-ir-scanner</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="libgirepository-1.0">
278 <term><filename class="libraryfile">libgirepository-1.0.so</filename></term>
279 <listitem>
280 <para>
281 provides an API to access the typelib metadata
282 </para>
283 <indexterm zone="gobject-introspection libgirepository-1.0">
284 <primary sortas="c-libgirepository-1.0">libgirepository-1.0.so</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 </variablelist>
290
291 </sect2>
292
293</sect1>
Note: See TracBrowser for help on using the repository browser.