source: x/lib/qtwebengine.xml@ 5cedfda

10.1 11.0 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 5cedfda was 5cedfda, checked in by Bruce Dubbs <bdubbs@…>, 17 months ago

Remove patch from qtwebengine

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

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