source: x/lib/qtwebengine.xml@ e671368

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since e671368 was e671368, checked in by Douglas R. Reno <renodr@…>, 11 months ago

Qtwebengine: Update ICU patch to resolve a build failure

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

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