source: x/lib/qtwebengine.xml@ 8ed3ef2a

10.1 11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 8ed3ef2a was 8ed3ef2a, checked in by Ken Moffat <ken@…>, 22 months ago

Patch QtWebEngine for breakage caused by glibc-2.33.

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

  • Property mode set to 100644
File size: 15.3 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 qtwebengine-major "5.15">
8 <!ENTITY qtwebengine-download-http "https://download.qt.io/archive/qt/&qtwebengine-major;/&qtwebengine-version;/submodules/qtwebengine-everywhere-src-&qtwebengine-version;.tar.xz">
9 <!ENTITY qtwebengine-download-ftp " ">
10 <!ENTITY qtwebengine-md5sum "c88cbe3158feb20c4feb3d54262feb23">
11 <!ENTITY qtwebengine-size "267 MB">
12 <!ENTITY qtwebengine-buildsize "4.4 GB (145 MB installed)">
13 <!ENTITY qtwebengine-time "64 SBU (Using parallelism=4)">
14]>
15
16<sect1 id="qtwebengine" xreflabel="qtwebengine-&qtwebengine-version;">
17 <?dbhtml filename="qtwebengine.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>QtWebEngine-&qtwebengine-version;</title>
25
26 <indexterm zone="qtwebengine">
27 <primary sortas="a-qtwebengine">qtwebengine</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to QtWebEngine</title>
32
33 <para>
34 <application>QtWebEngine</application> integrates
35 <application>chromium</application>'s web capabilities into Qt. It
36 ships with its own copy of ninja which it uses for the build if it cannot
37 find a system copy, and various copies of libraries from ffmpeg, icu,
38 libvpx, and zlib (including libminizip) which have been forked by the
39 <application>chromium</application> developers.
40 </para>
41
42 &lfs10_checked;
43
44 <note>
45 <para>
46 By default, ninja will use all online CPUs +2 (if at least 4 exist),
47 even if they are not available to the current task because the build
48 terminal has been restricted with 'taskset'. To work around this, see
49 the Command Explanations below.
50 </para>
51
52 <para>
53 Unusually, the shipped GN build system (used to create the Ninja files)
54 requires a static <filename class="libraryfile">libstdc++.a</filename>
55 although the installed libraries correctly use the shared version. If
56 that static library is not present, the build will fail quite quickly.
57 Please note that if you try to build webengine as part of
58 <application>Qt</application> and the static library is not available,
59 that build will either complete without installing webengine, or else
60 fail during the install (both variants have been observed in 5.12.0).
61 </para>
62 </note>
63
64 <bridgehead renderas="sect3">Package Information</bridgehead>
65 <itemizedlist spacing="compact">
66 <listitem>
67 <para>
68 Download (HTTP): <ulink url="&qtwebengine-download-http;"/>
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Download (FTP): <ulink url="&qtwebengine-download-ftp;"/>
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 Download MD5 sum: &qtwebengine-md5sum;
79 </para>
80 </listitem>
81 <listitem>
82 <para>
83 Download size: &qtwebengine-size;
84 </para>
85 </listitem>
86 <listitem>
87 <para>
88 Estimated disk space required: &qtwebengine-buildsize;
89 </para>
90 </listitem>
91 <listitem>
92 <para>
93 Estimated build time: &qtwebengine-time;
94 </para>
95 </listitem>
96 </itemizedlist>
97
98 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
99 <itemizedlist spacing="compact">
100 <listitem>
101 <para>
102 Required patch:
103 <ulink url="&patch-root;/qtwebengine-everywhere-src-&qtwebengine-version;-ICU68-2.patch"/>
104 </para>
105 </listitem>
106 <listitem>
107 <para>
108 Required patch:
109 <ulink url="&patch-root;/qtwebengine-everywhere-src-&qtwebengine-version;-glibc233-1.patch"/>
110 </para>
111 </listitem>
112 </itemizedlist>
113
114 <bridgehead renderas="sect3">qtwebengine Dependencies</bridgehead>
115
116 <bridgehead renderas="sect4">Required</bridgehead>
117 <!-- the qmake output tends to be misleading. 'khr' is from Mesa -->
118 <para role="required">
119 <xref linkend="nss"/>,
120 <xref linkend="python2"/>, and
121 <xref linkend='qt5'/>
122 </para>
123
124 <bridgehead renderas="sect4">Recommended</bridgehead>
125 <note>
126 <para>
127 If these packages are not installed, the build process will compile and
128 install its own (perhaps older) version, with the side effect of
129 increasing build and installed disk space and build time.
130 </para>
131 </note>
132
133 <para role="recommended">
134 either <xref linkend="alsa-lib"/> or
135 <xref linkend="pulseaudio"/> (or both),
136 <xref linkend="ffmpeg"/>,
137 <xref linkend="icu"/>,
138 <xref linkend="libwebp"/>,
139 <xref linkend="libxslt"/>, and
140 <xref linkend="opus"/>
141 </para>
142
143 <bridgehead renderas="sect4">Optional</bridgehead>
144 <para role="optional">
145 <xref linkend="libevent"/>,
146 <xref linkend="poppler"/>,
147 <ulink url="https://github.com/open-source-parsers/jsoncpp/releases">jsoncpp</ulink>,
148 <ulink url="https://github.com/cisco/libsrtp/releases">libsrtp</ulink>,
149 <ulink url="http://google.github.io/snappy/">snappy</ulink>
150 </para>
151
152 <para condition="html" role="usernotes">
153 User Notes: <ulink url="&blfs-wiki;/qtwebengine"/>
154 </para>
155 </sect2>
156
157 <sect2 role="installation">
158 <title>Installation of qtwebengine</title>
159
160 <para>
161 First, ensure that the local headers are available when not building as
162 part of the complete <xref linkend="qt5"/>:
163 </para>
164
165<screen><userinput>find -type f -name "*.pr[io]" |
166 xargs sed -i -e 's|INCLUDEPATH += |&amp;$$QTWEBENGINE_ROOT/include |'</userinput></screen>
167
168 <para>
169 Next, apply a patch that fixes the build with system ICU version 68.1.
170 </para>
171
172<screen><userinput remap="pre">patch -Np1 -i ../qtwebengine-everywhere-src-&qtwebengine-version;-ICU68-2.patch</userinput></screen>
173
174 <para>
175 Now apply a patch to fix an issue introduced by glibc-2.33.
176 </para>
177
178<screen><userinput remap="pre">patch -Np1 -i ../qtwebengine-everywhere-src-&qtwebengine-version;-glibc233-1.patch</userinput></screen>
179
180 <para>
181 Next, allow the pulseaudio library to be linked at build time, instead
182 of run time. This also prevents an issue with newer pulseaudio:
183 </para>
184
185<screen><userinput>sed -e '/link_pulseaudio/s/false/true/' \
186 -i src/3rdparty/chromium/media/media_options.gni</userinput></screen>
187
188 <para>
189 Finally, fix a change in the build system which allows its developers to
190 pass e.g. -j20 to make (for quick tests of some areas) but breaks the
191 build with LFS's use of the NINJAJOBS environment variable:
192 </para>
193
194<!-- editors: See thread at
195http://lists.linuxfromscratch.org/pipermail/blfs-dev/2019-December/036996.html
196et.seq, particularly 037002.html which shows the commit near the end. -->
197
198<screen><userinput>sed -i 's/NINJAJOBS/NINJA_JOBS/' src/core/gn_run.pro</userinput></screen>
199
200 <para>
201 If an older version of the package's main library has been installed,
202 when the package is built separately it will link to that in preference
203 to its own not-yet-installed version, and fail because of missing symbols.
204 Prevent that by, as the <systemitem class="username">root</systemitem>
205 user, moving the symlink out of the way:
206 </para>
207
208<screen role="root"><userinput>if [ -e ${QT5DIR}/lib/libQt5WebEngineCore.so ]; then
209 mv -v ${QT5DIR}/lib/libQt5WebEngineCore.so{,.old}
210fi</userinput></screen>
211
212 <para>
213 Install <application>qtwebengine</application> by running the following
214 commands:
215 </para>
216
217<screen><userinput>mkdir build &amp;&amp;
218cd build &amp;&amp;
219
220qmake .. -- -system-ffmpeg -webengine-icu &amp;&amp;
221make</userinput></screen>
222
223<!--
224 <para>
225 if you wish to build the HTML documentation, issue:
226 </para>
227
228<screen><userinput>make docs</userinput></screen>
229-->
230 <para>
231 This package does not come with a test suite.
232 </para>
233
234 <para>
235 Now, as the <systemitem class="username">root</systemitem> user:
236 </para>
237
238<screen role="root"><userinput>make install</userinput></screen>
239 <!-- EDITORS NOTE: If you are updating this package, use INSTALL_ROOT=
240 instead of DESTDIR= -->
241<!--
242 <para>
243 If you built the HTML documentation, install it with:
244 </para>
245
246<screen role="root"><userinput>make install_docs</userinput></screen>
247-->
248 <para>
249 Remove references to the build directory from installed library
250 dependency (prl) files by running the following
251 commands as the <systemitem class="username">root</systemitem> user:
252 </para>
253
254<screen role="root"><userinput>find $QT5DIR/ -name \*.prl \
255 -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;</userinput></screen>
256 </sect2>
257
258 <sect2 role="commands">
259 <title>Command Explanations</title>
260
261 <para>
262 <command>qmake</command>: This will build the included copy of
263 <application>ninja</application> if it is not already installed
264 and use it to configure the build.
265 </para>
266
267 <para>
268 <command>-- -system-ffmpeg -webengine-icu</command>: If any options are
269 passed to qmake they must come after '--' which must follow '..' that points
270 to the main directory. The options here cause it to use system ffmpeg and
271 system icu. If built as part of full Qt5, the system icu is automatically
272 used (only) by Qt5Core if it is available, but unless this option is used
273 webengine will always use its shipped copy of icu, adding time and space
274 to the build.
275 </para>
276
277 <!--
278 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
279 href="../../xincludes/SIOCGSTAMP.xml"/>
280 -->
281
282 <para>
283 <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
284 recognize the NINJAJOBS environment variable, this command will run system
285 ninja with the specified number of jobs (i.e. 4).
286 There are several reasons why you might want to do this:
287 </para>
288
289 <itemizedlist>
290 <listitem>
291 <para>
292 Building on a subset of CPUs allows measuring the build time
293 for that number of processors or to run other CPU-intensive tasks on
294 other cores.
295 </para>
296 </listitem>
297 <listitem>
298 <para>
299 Improving the build speed on a less-well endowed 4-core machine.
300 On a machine with a powerful CPU and plenty of RAM, running N+2
301 jobs (the ninja default for 4+ cores) for the large working sets
302 of the C++ compiles in this package is typically only marginally
303 faster than running N jobs at a time. But for a machine with less
304 memory it can be much slower.
305 </para>
306 </listitem>
307 <listitem>
308 <para>
309 Reducing the number of cores being used on long running, CPU
310 intensive packages may alleviate heat problems.
311 </para>
312 </listitem>
313 </itemizedlist>
314
315 </sect2>
316
317 <sect2 role="configuration">
318 <title>Configuring QtWebEngine</title>
319
320 <sect3 id="qtwebengine-config">
321 <title>Configuration Information</title>
322
323 <para>
324 If you are upgrading from an older minor version of this
325 application, for some webpages to load you may need to
326 clear the <emphasis>browser</emphasis> caches, e.g. for
327 <application>falkon</application> they will be found in
328 <filename class="directory">~/.cache/falkon/</filename>.
329 You will need to do this if the browser starts to render
330 the page and then changes to a blank tab with a message
331 that something went wrong, and a button to Retry. Even
332 after removing the old caches, you may need to retry a
333 few times for each affected tab.
334 </para>
335
336 </sect3>
337
338 </sect2>
339
340
341 <sect2 role="content">
342 <title>Contents</title>
343
344 <segmentedlist>
345 <segtitle>Installed Programs</segtitle>
346 <segtitle>Installed Libraries</segtitle>
347 <segtitle>Installed Directories</segtitle>
348
349 <seglistitem>
350 <seg>
351 qtwebengine_convert_dict and
352 QtWebEngineProcess (in $QT5DIR/libexec)
353 </seg>
354 <seg>
355 libQt5Pdf.so,
356 libQt5PdfWidgets.so,
357 libQt5WebEngineCore.so,
358 libQt5WebEngine.so, and
359 libQt5WebEngineWidgets.so
360 </seg>
361 <seg>
362 $QT5DIR/include/QtPdf,
363 $QT5DIR/include/QtPdfWidgets,
364 $QT5DIR/include/QtWebEngine,
365 $QT5DIR/include/QtWebEngineCore,
366 $QT5DIR/include/QtWebEngineWidgets,
367 $QT5DIR/qml/QtWebEngine, and
368 $QT5DIR/translations/qtwebengine_locales
369 </seg>
370 </seglistitem>
371 </segmentedlist>
372
373 <variablelist>
374 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
375 <?dbfo list-presentation="list"?>
376 <?dbhtml list-presentation="table"?>
377
378 <varlistentry id="qtwebengine_convert_dict">
379 <term><command>qtwebengine_convert_dict</command></term>
380 <listitem>
381 <para>
382 converts hunspell dictionaries (<literal>.dic</literal>) to chromium
383 format (<literal>.bdic</literal>)
384 </para>
385 <indexterm zone="qtwebengine qtwebengine_convert_dict">
386 <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="QtWebEngineProcess">
392 <term><command>QtWebEngineProcess</command></term>
393 <listitem>
394 <para>
395 is a libexec program which runs a zygote process (one that listens
396 for spawn requests from a master process and will fork itself in
397 response).
398 </para>
399 <indexterm zone="qtwebengine QtWebEngineProcess">
400 <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="libQtWebEngine-lib">
406 <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
407 <listitem>
408 <para>
409 provides QML types for rendering web content within a QML application.
410 </para>
411 <indexterm zone="qtwebengine libQtWebEngine-lib">
412 <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="libQtWebEngineCore">
418 <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
419 <listitem>
420 <para>
421 provides public API shared by both QtWebEngine and QtWebEngineWidgets.
422 </para>
423 <indexterm zone="qtwebengine libQtWebEngineCore">
424 <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428
429 <varlistentry id="libQtWebEngineWidgets">
430 <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
431 <listitem>
432 <para>
433 provides a web browser engine as well as C++ classes to render and
434 interact with web content.
435 </para>
436 <indexterm zone="qtwebengine libQtWebEngineWidgets">
437 <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 </variablelist>
443 </sect2>
444</sect1>
Note: See TracBrowser for help on using the repository browser.