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 | <!-- URL if there is a public release
|
---|
9 | <!ENTITY qtwebengine-download-http "https://download.qt.io/archive/qt/&qtwebengine-major;/&qtwebengine-version;/submodules/qtwebengine-everywhere-src-&qtwebengine-version;.tar.xz">
|
---|
10 | URL for a prepared git version -->
|
---|
11 | <!ENTITY qtwebengine-download-http "&sources-anduin-http;/qtwebengine/qtwebengine-&qtwebengine-version;.tar.xz">
|
---|
12 | <!ENTITY qtwebengine-download-ftp " ">
|
---|
13 | <!ENTITY qtwebengine-md5sum "296f61f84a489088ffd237fbcd052c9e">
|
---|
14 | <!ENTITY qtwebengine-size "307 MB">
|
---|
15 | <!ENTITY qtwebengine-buildsize "5.1 GB (153 MB installed)">
|
---|
16 | <!ENTITY qtwebengine-time "73 SBU (Using parallelism=4)">
|
---|
17 | ]>
|
---|
18 |
|
---|
19 | <sect1 id="qtwebengine" xreflabel="qtwebengine-&qtwebengine-version;">
|
---|
20 | <?dbhtml filename="qtwebengine.html"?>
|
---|
21 |
|
---|
22 |
|
---|
23 | <title>QtWebEngine-&qtwebengine-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="qtwebengine">
|
---|
26 | <primary sortas="a-qtwebengine">qtwebengine</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to QtWebEngine</title>
|
---|
31 |
|
---|
32 | <para>
|
---|
33 | <application>QtWebEngine</application> integrates
|
---|
34 | <application>chromium</application>'s web capabilities into Qt. It
|
---|
35 | ships with its own copy of ninja which it uses for the build if it cannot
|
---|
36 | find a system copy, and various copies of libraries from ffmpeg, icu,
|
---|
37 | libvpx, and zlib (including libminizip) which have been forked by the
|
---|
38 | <application>chromium</application> developers.
|
---|
39 | </para>
|
---|
40 |
|
---|
41 | <para>
|
---|
42 | This package and browsers using it may be useful if you need to use a
|
---|
43 | website designed for google chrome, or chromium, browsers.
|
---|
44 | </para>
|
---|
45 |
|
---|
46 | <important>
|
---|
47 | <para>
|
---|
48 | Qt-5.15 reached End Of Life on 26 May 2023. Extended lifetime Qt5.15 LTS
|
---|
49 | has been extended until 26th May 2025 for those with subscription licenses.
|
---|
50 | Because qtwebengine uses chromium code under the LGPL, it appears that any
|
---|
51 | new backported CVE fixes for QtWebEngine will be available after Qt makes
|
---|
52 | public releases of its current versions.
|
---|
53 | </para>
|
---|
54 | </important>
|
---|
55 |
|
---|
56 | <warning>
|
---|
57 | <para>
|
---|
58 | QtWebEngine uses a forked copy of chromium, and is therefore vulnerable
|
---|
59 | to many issues found there. The Qt developers have always preferred to
|
---|
60 | make releases at the same time as the rest of Qt (rather than adding
|
---|
61 | emergency fixes), but with stable versions getting released after the
|
---|
62 | current development version. Now that they are keen to move to Qt6, the
|
---|
63 | 5.15.3 and later Qt-5.15 releases are initially only available to paying
|
---|
64 | customers. QtWebEngine is something of an exception because of its LGPL
|
---|
65 | licence, but getting the git sources (with the forked chromium submodule)
|
---|
66 | to a position where they will successfully build on a current BLFS system
|
---|
67 | can take a lot of effort and therefore updates to the book may be delayed.
|
---|
68 | </para>
|
---|
69 |
|
---|
70 | <para>
|
---|
71 | It seems likely that future 5.15-series versions will also be released
|
---|
72 | long after the chromium vulnerabilities are known, but fixes for
|
---|
73 | QtWebEngine can be found in git and the editors take the view that
|
---|
74 | known vulnerabilities in browsers should be fixed.
|
---|
75 | </para>
|
---|
76 |
|
---|
77 | <para> <!-- for git versions -->
|
---|
78 | The tarball linked to below was created from the 5.15.15 git branch
|
---|
79 | and the 87-branch of the chromium submodule (which is forked from
|
---|
80 | chromium). See the GIT-VERSIONS file in the tarball for details of the
|
---|
81 | latest commits.
|
---|
82 | </para>
|
---|
83 | </warning>
|
---|
84 |
|
---|
85 | <!-- note for editors on obtaining webengine from git.
|
---|
86 | First (if you do not already have a past version)
|
---|
87 | git clone git://code.qt.io/qt/qtwebengine.git
|
---|
88 | git submodule init -
|
---|
89 | that will report qtwebengine-chromium.git registered for src/3rdparty
|
---|
90 | now find the main branch names:
|
---|
91 | git fetch origin
|
---|
92 | git branch -r
|
---|
93 | after a release is prepared (even if the rest is not public), the 5.15
|
---|
94 | branch now seems to get updated and might be what you want. But in the
|
---|
95 | approach to 5.15.6 the backported CVE and other security fixes were only
|
---|
96 | applied to 5.15.6. So, assuming that a 5.15.7 branch now exists,
|
---|
97 | git checkout origin/5.15.7
|
---|
98 | Confirm that HEAD is where you expected.
|
---|
99 | Now go to src/3rdparty
|
---|
100 | git fetch origin
|
---|
101 | git branch -r
|
---|
102 | The required branch is likely to be 87-branch unless there is a newer one
|
---|
103 | mentioned in the 5.15 cgit web page (below).
|
---|
104 | git checkout origin/87-branch (or whatever)
|
---|
105 | Use git log or git tk to look at its HEAD and check it seems appropriate.
|
---|
106 | If this doesn't work, use 'git submodule update'
|
---|
107 |
|
---|
108 | To decide when it might be worth creating a new tarball, periodically keep
|
---|
109 | an eye on https://code.qt.io/cgit/qt/qtwebengine.git/ (currently, the 5.15.6
|
---|
110 | branch, 5.15.7 might get used later). The interesting items are CVE fixes
|
---|
111 | for known chromium vulnerabilities, as well as numbered Security bugs -
|
---|
112 | again, these relate to chromium.
|
---|
113 |
|
---|
114 | When I noticed some updates in late March I was searching for one of the
|
---|
115 | CVEs mentioned, and google found a link to a review page for Michael Brüning
|
---|
116 | at https://codereview.qt.nokia.com/q/owner:michael.bruning%2540qt.io. At that
|
---|
117 | time I could see various unmerged items, so I waited. The items for the
|
---|
118 | 90-based chromium module are not relevant to 5.15-series (possibly they will
|
---|
119 | be for qtwebengine-6+). Review queues for other Qt employees might be found
|
---|
120 | in a similar way, but remember that everythng EXCEPT qtwebengine and chromium
|
---|
121 | is private to Qt until they choose to release it.
|
---|
122 |
|
---|
123 | NOTE: the 3rdparty/chromium tree may contain more patches than have been
|
---|
124 | merged into the current 5.15.x branch. Any patches after what was in the
|
---|
125 | last 'update chromium' merge in qtwebengine occasionally break the build.
|
---|
126 |
|
---|
127 | After merging the contents of the qtwebengine and src/3rdparty git extracts,
|
---|
128 | in the top level please create a GIT-VERSIONS file summarising the HEAD
|
---|
129 | commits of both parts, as a reminder of where we are up to. I've nove added
|
---|
130 | a CVE-fixes to keep track of what has been fixed (comits before 5.15.2 did not
|
---|
131 | mention the CVEs until they were detailed in a release).
|
---|
132 |
|
---|
133 | Now create tarballs - 'git archive' does not work across submodule boundaries,
|
---|
134 | so you need to create one archive from the top of qtwebengine/ and another
|
---|
135 | from the top of src/3rdparty (chromium, gn, ninja are apparently all part of
|
---|
136 | the qtwebengine-chromium module). Then in a work area untar the qtwebengine
|
---|
137 | tarball, go down to src/3rdparty and untar the submodule tarball.
|
---|
138 | Decide on what to call the result and create a full xz tarball using tar -cJf.
|
---|
139 |
|
---|
140 | NOTE: To use git archive, use something like this:
|
---|
141 | git archive - -format tar.gz - -output qtwebengine.tar.gz HEAD
|
---|
142 | git archive - -format tar.gz - -output chromium.tar.gz HEAD
|
---|
143 |
|
---|
144 | UPDATE: Since we have to host the tarball, and it is over 300MB, it makes
|
---|
145 | sense to create a patch for subsequent fixes (for the first version, 314KB
|
---|
146 | including the updates to the GIT-VERSIONS file). For future updates, view
|
---|
147 | the current updates patch to see the previous commits. When the new commits
|
---|
148 | have been applied, rename the updated version to 'b', but untar the
|
---|
149 | unpatched tarball as 'a' and then diff a to b in the usual manner to get
|
---|
150 | all updates since the tarball was created.
|
---|
151 |
|
---|
152 | For our own releases, probably best to create a fresh tarball.
|
---|
153 |
|
---|
154 | end of note for editors -->
|
---|
155 |
|
---|
156 | &lfs120_checked;
|
---|
157 |
|
---|
158 | <warning>
|
---|
159 | <para>
|
---|
160 | By default, ninja will use all online CPUs +2 (if at least 4 exist),
|
---|
161 | even if they are not available to the current task because the build
|
---|
162 | terminal has been restricted with 'taskset'. In BLFS, this package
|
---|
163 | takes more time to build than than any other. In one example,
|
---|
164 | the build of this package crashed at about the 90 percent point
|
---|
165 | due to an out of memory problem on a system with 24 cores and 32 GB
|
---|
166 | of memory.
|
---|
167 | </para>
|
---|
168 |
|
---|
169 | <para>
|
---|
170 | To work around this, see the Command Explanations below.
|
---|
171 | </para>
|
---|
172 | </warning>
|
---|
173 |
|
---|
174 | <note>
|
---|
175 | <para>
|
---|
176 | If you are upgrading and have installed a newer version of <xref
|
---|
177 | linkend='icu'/> since you last installed <xref linkend='qt5'/>, you
|
---|
178 | will need to reinstall Qt5 before upgrading, otherwise the final link
|
---|
179 | of this package will fail with a warning that the version of icu
|
---|
180 | libraries needed by libQt5Core.so may conflict with the version
|
---|
181 | used for this package.
|
---|
182 | </para>
|
---|
183 |
|
---|
184 | <para>
|
---|
185 | Unusually, the shipped GN build system (used to create the Ninja files)
|
---|
186 | requires a static <filename class="libraryfile">libstdc++.a</filename>
|
---|
187 | although the installed libraries correctly use the shared version. If
|
---|
188 | that static library is not present, the build will fail quite quickly.
|
---|
189 | Please note that if you try to build webengine as part of
|
---|
190 | <application>Qt</application> and the static library is not available,
|
---|
191 | that build will either complete without installing webengine, or else
|
---|
192 | fail during the install (both variants were observed in 5.12.0).
|
---|
193 | </para>
|
---|
194 | </note>
|
---|
195 |
|
---|
196 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
197 | <itemizedlist spacing="compact">
|
---|
198 | <listitem>
|
---|
199 | <para>
|
---|
200 | Download (HTTP): <ulink url="&qtwebengine-download-http;"/>
|
---|
201 | </para>
|
---|
202 | </listitem>
|
---|
203 | <listitem>
|
---|
204 | <para>
|
---|
205 | Download (FTP): <ulink url="&qtwebengine-download-ftp;"/>
|
---|
206 | </para>
|
---|
207 | </listitem>
|
---|
208 | <listitem>
|
---|
209 | <para>
|
---|
210 | Download MD5 sum: &qtwebengine-md5sum;
|
---|
211 | </para>
|
---|
212 | </listitem>
|
---|
213 | <listitem>
|
---|
214 | <para>
|
---|
215 | Download size: &qtwebengine-size;
|
---|
216 | </para>
|
---|
217 | </listitem>
|
---|
218 | <listitem>
|
---|
219 | <para>
|
---|
220 | Estimated disk space required: &qtwebengine-buildsize;
|
---|
221 | </para>
|
---|
222 | </listitem>
|
---|
223 | <listitem>
|
---|
224 | <para>
|
---|
225 | Estimated build time: &qtwebengine-time;
|
---|
226 | </para>
|
---|
227 | </listitem>
|
---|
228 | </itemizedlist>
|
---|
229 |
|
---|
230 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
231 | <itemizedlist spacing="compact">
|
---|
232 | <!--<listitem>
|
---|
233 | <para>
|
---|
234 | Required patch:
|
---|
235 | <!\-\- keep links for releases and git versions as a reminder
|
---|
236 | that the tarball names names differ
|
---|
237 | <ulink url="&patch-root;/qtwebengine-everywhere-src-&qtwebengine-version;-ICU68-2.patch"/> \-\->
|
---|
238 |
|
---|
239 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-5.15.7-1.patch"/>
|
---|
240 | </para>
|
---|
241 | </listitem>-->
|
---|
242 | <listitem>
|
---|
243 | <para>
|
---|
244 | Required patch:
|
---|
245 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-build_fixes-1.patch"/>
|
---|
246 | </para>
|
---|
247 | </listitem>
|
---|
248 | <listitem>
|
---|
249 | <para>
|
---|
250 | Required patch:
|
---|
251 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-ffmpeg5_fixes-1.patch"/>
|
---|
252 | </para>
|
---|
253 | </listitem>
|
---|
254 | <!--
|
---|
255 | <listitem>
|
---|
256 | <para>
|
---|
257 | Required patch:
|
---|
258 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-icu_73-1.patch"/>
|
---|
259 | </para>
|
---|
260 | </listitem>
|
---|
261 | -->
|
---|
262 | </itemizedlist>
|
---|
263 |
|
---|
264 | <bridgehead renderas="sect3">qtwebengine Dependencies</bridgehead>
|
---|
265 |
|
---|
266 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
267 | <!-- the qmake output tends to be misleading. 'khr' is from Mesa -->
|
---|
268 | <para role="required">
|
---|
269 | <xref linkend="nodejs"/>,
|
---|
270 | <xref linkend="nss"/>,
|
---|
271 | <xref linkend="pciutils"/>, and
|
---|
272 | <!-- <xref linkend="python2"/>, and -->
|
---|
273 | (<xref linkend='qt5'/> or
|
---|
274 | <xref role="nodep" linkend='qt5-components'/> with qtlocation and qtwebchannel)
|
---|
275 | </para>
|
---|
276 |
|
---|
277 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
278 | <note>
|
---|
279 | <para>
|
---|
280 | If these packages are not installed, the build process will compile and
|
---|
281 | install its own (perhaps older) version, with the side effect of
|
---|
282 | increasing build and installed disk space and build time.
|
---|
283 | </para>
|
---|
284 | </note>
|
---|
285 |
|
---|
286 | <para role="recommended">
|
---|
287 | either <xref linkend="alsa-lib"/> or
|
---|
288 | <xref linkend="pulseaudio"/> (or both),
|
---|
289 | <xref linkend="ffmpeg"/>,
|
---|
290 | <!-- awkward wording - libxslt needs libxml2, if libxml2 is built
|
---|
291 | before icu then the *shipped* icu will be used -->
|
---|
292 | <xref linkend="icu"/> (built before <xref linkend="libxml2"/>) ,
|
---|
293 | <xref linkend="libwebp"/>,
|
---|
294 | <xref linkend="libxslt"/>, and
|
---|
295 | <xref linkend="opus"/>
|
---|
296 | </para>
|
---|
297 |
|
---|
298 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
299 | <para role="optional">
|
---|
300 | <xref linkend="libevent"/>,
|
---|
301 | <xref linkend="mitkrb"/>,
|
---|
302 | <xref linkend="pipewire"/>,
|
---|
303 | <xref linkend="poppler"/>,
|
---|
304 | <ulink url="https://github.com/open-source-parsers/jsoncpp/releases">jsoncpp</ulink>,
|
---|
305 | <ulink url="https://github.com/cisco/libsrtp/releases">libsrtp</ulink>,
|
---|
306 | <ulink url="https://google.github.io/snappy/">snappy</ulink>
|
---|
307 | </para>
|
---|
308 |
|
---|
309 | <para condition="html" role="usernotes">
|
---|
310 | Editor Notes: <ulink url="&blfs-wiki;/qtwebengine"/>
|
---|
311 | </para>
|
---|
312 | </sect2>
|
---|
313 |
|
---|
314 | <sect2 role="installation">
|
---|
315 | <title>Installation of qtwebengine</title>
|
---|
316 |
|
---|
317 | <!-- following merely commented instead of deleted, in case we need to
|
---|
318 | drop back when a future version of python3 is released -->
|
---|
319 | <!--<note>
|
---|
320 | <para>
|
---|
321 | Unlike version 5.15.2, the chromium-derived build system now needs
|
---|
322 | <command>python</command> to be available and to be python2. In
|
---|
323 | BLFS-10.1 the creation of the python symlink was removed as a step
|
---|
324 | towards eventually getting rid of python2 (other old packages which
|
---|
325 | need python2 usually work by invoking python2). If you are still
|
---|
326 | using an earlier version of BLFS where
|
---|
327 | <filename>/usr/bin/python</filename> exists, you can skip the
|
---|
328 | commands to create the symlink, and to later remove it.
|
---|
329 | </para>
|
---|
330 | </note>
|
---|
331 |
|
---|
332 | <para>
|
---|
333 | First, as the <systemitem class="username">root</systemitem>
|
---|
334 | user, create the python symlink:
|
---|
335 | </para>
|
---|
336 |
|
---|
337 | <screen role="root"><userinput>ln -svf /usr/bin/python{2,}</userinput></screen>-->
|
---|
338 |
|
---|
339 |
|
---|
340 | <!--<para>
|
---|
341 | Now apply a patch to update from 5.15.6 to the security and other fixes
|
---|
342 | contained in the 5.15.7 source:
|
---|
343 | </para>
|
---|
344 |
|
---|
345 | <screen><userinput remap="pre">patch -Np1 -i ../qtwebengine-&qtwebengine-version;-5.15.7-1.patch</userinput></screen>-->
|
---|
346 |
|
---|
347 | <para>
|
---|
348 | Apply a patch to fix several issues that can prevent the build from completing,
|
---|
349 | and to force it to use python3:
|
---|
350 | </para>
|
---|
351 |
|
---|
352 | <screen><userinput remap="pre">patch -Np1 -i ../qtwebengine-&qtwebengine-version;-build_fixes-1.patch</userinput></screen>
|
---|
353 |
|
---|
354 | <para>
|
---|
355 | Apply a patch that resolves problems when building with ffmpeg-5 and later:
|
---|
356 | </para>
|
---|
357 |
|
---|
358 | <screen><userinput remap="pre">patch -Np1 -i ../qtwebengine-&qtwebengine-version;-ffmpeg5_fixes-1.patch</userinput></screen>
|
---|
359 | <!--
|
---|
360 | <para>
|
---|
361 | Apply a patch that resolves problems when building with icu-73 and later:
|
---|
362 | </para>
|
---|
363 |
|
---|
364 | <screen><userinput remap="pre">patch -Np1 -i ../qtwebengine-&qtwebengine-version;-icu_73-1.patch</userinput></screen>
|
---|
365 |
|
---|
366 | -->
|
---|
367 | <!-- start of commands for git versions only -->
|
---|
368 | <para>
|
---|
369 | Although the build_fixes patch has ensured that git is not invoked during the build,
|
---|
370 | the build system has labyrinthine rules of byzantine complexity, and in
|
---|
371 | particular trying to build without two <filename>.git</filename> directories
|
---|
372 | will lead to it eventually falling into unexpected and unbuildable code
|
---|
373 | which references a private header that has not been created. Avoid this
|
---|
374 | by creating the required directories:
|
---|
375 | </para>
|
---|
376 |
|
---|
377 | <screen><userinput>mkdir -pv .git src/3rdparty/chromium/.git</userinput></screen>
|
---|
378 |
|
---|
379 | <para>
|
---|
380 | Because this version of qtwebengine is aimed at a later release than the
|
---|
381 | current public releases, change it to build for qt-&qt5-version; using a
|
---|
382 | sed:
|
---|
383 | </para>
|
---|
384 |
|
---|
385 | <screen><userinput>sed -e '/^MODULE_VERSION/s/5.*/&qt5-version;/' -i .qmake.conf</userinput></screen>
|
---|
386 | <!-- end of commands for git versions only -->
|
---|
387 |
|
---|
388 | <para>
|
---|
389 | Now, ensure that the local headers are available when not building as
|
---|
390 | part of the complete <xref linkend="qt5"/>:
|
---|
391 | </para>
|
---|
392 |
|
---|
393 | <screen><userinput>find -type f -name "*.pr[io]" |
|
---|
394 | xargs sed -i -e 's|INCLUDEPATH += |&$$QTWEBENGINE_ROOT/include |'</userinput></screen>
|
---|
395 |
|
---|
396 | <para>
|
---|
397 | Next, allow the pulseaudio library to be linked at build time, instead
|
---|
398 | of run time. This also prevents an issue with newer pulseaudio:
|
---|
399 | </para>
|
---|
400 |
|
---|
401 | <screen><userinput>sed -e '/link_pulseaudio/s/false/true/' \
|
---|
402 | -i src/3rdparty/chromium/media/media_options.gni</userinput></screen>
|
---|
403 |
|
---|
404 | <para>
|
---|
405 | Next, fix the build tools so they can be run with Python-3.11+:
|
---|
406 | </para>
|
---|
407 |
|
---|
408 | <screen><userinput>sed -e 's/\^(?i)/(?i)^/' \
|
---|
409 | -i src/3rdparty/chromium/tools/metrics/ukm/ukm_model.py &&
|
---|
410 | sed -e "s/'rU'/'r'/" \
|
---|
411 | -i src/3rdparty/chromium/tools/grit/grit/util.py</userinput></screen>
|
---|
412 |
|
---|
413 | <para>
|
---|
414 | Finally, fix a change in the build system which allows its developers to
|
---|
415 | pass e.g. -j20 to make (for quick tests of some areas) but breaks the
|
---|
416 | build with LFS's use of the NINJAJOBS environment variable:
|
---|
417 | </para>
|
---|
418 |
|
---|
419 | <!-- editors: See thread at
|
---|
420 | http://lists.linuxfromscratch.org/pipermail/blfs-dev/2019-December/036996.html
|
---|
421 | et.seq, particularly 037002.html which shows the commit near the end. -->
|
---|
422 |
|
---|
423 | <screen><userinput>sed -i 's/NINJAJOBS/NINJA_JOBS/' src/core/gn_run.pro</userinput></screen>
|
---|
424 |
|
---|
425 | <!-- now that we always install this as 5.15.2, this seems to be redundant
|
---|
426 | <para>
|
---|
427 | If an older version of the package's main library has been installed,
|
---|
428 | when the package is built separately it will link to that in preference
|
---|
429 | to its own not-yet-installed version, and fail because of missing symbols.
|
---|
430 | Prevent that by, as the <systemitem class="username">root</systemitem>
|
---|
431 | user, moving the symlink out of the way:
|
---|
432 | </para>
|
---|
433 |
|
---|
434 | <screen role="root"><userinput>if [ -e ${QT5DIR}/lib/libQt5WebEngineCore.so ]; then
|
---|
435 | mv -v ${QT5DIR}/lib/libQt5WebEngineCore.so{,.old}
|
---|
436 | fi</userinput></screen>-->
|
---|
437 |
|
---|
438 | <!--<para>
|
---|
439 | The last fix is needed to build with gcc-12:
|
---|
440 | </para>
|
---|
441 |
|
---|
442 | <screen><userinput>sed -e '/#include/i#include <vector>' \
|
---|
443 | -i src/3rdparty/chromium/third_party/skia/src/utils/SkParseColor.cpp</userinput></screen>-->
|
---|
444 |
|
---|
445 | <para>
|
---|
446 | Install <application>qtwebengine</application> by running the following
|
---|
447 | commands:
|
---|
448 | </para>
|
---|
449 |
|
---|
450 | <screen><userinput>mkdir build &&
|
---|
451 | cd build &&
|
---|
452 | qmake .. -- -system-ffmpeg -proprietary-codecs -webengine-icu &&
|
---|
453 | make</userinput></screen>
|
---|
454 |
|
---|
455 | <!--
|
---|
456 | <para>
|
---|
457 | if you wish to build the HTML documentation, issue:
|
---|
458 | </para>
|
---|
459 |
|
---|
460 | <screen><userinput>make docs</userinput></screen>
|
---|
461 | -->
|
---|
462 | <para>
|
---|
463 | This package does not come with a test suite.
|
---|
464 | </para>
|
---|
465 |
|
---|
466 | <para>
|
---|
467 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
468 | </para>
|
---|
469 |
|
---|
470 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
471 |
|
---|
472 | <!-- EDITORS NOTE: If you are updating this package, use INSTALL_ROOT=
|
---|
473 | instead of DESTDIR= -->
|
---|
474 | <!--
|
---|
475 | <para>
|
---|
476 | If you built the HTML documentation, install it with:
|
---|
477 | </para>
|
---|
478 |
|
---|
479 | <screen role="root"><userinput>make install_docs</userinput></screen>
|
---|
480 | -->
|
---|
481 | <para>
|
---|
482 | Remove references to the build directory from installed library
|
---|
483 | dependency (prl) files by running the following
|
---|
484 | commands as the <systemitem class="username">root</systemitem> user:
|
---|
485 | </para>
|
---|
486 |
|
---|
487 | <screen role="root"><userinput>find $QT5DIR/ -name \*.prl \
|
---|
488 | -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;</userinput></screen>
|
---|
489 |
|
---|
490 | <!--<para>
|
---|
491 | Finally, as the <systemitem class="username">root</systemitem>
|
---|
492 | user, remove the python symlink:
|
---|
493 | </para>
|
---|
494 |
|
---|
495 | <screen role="root"><userinput>rm -v /usr/bin/python</userinput></screen>-->
|
---|
496 | </sect2>
|
---|
497 |
|
---|
498 | <sect2 role="commands">
|
---|
499 | <title>Command Explanations</title>
|
---|
500 |
|
---|
501 | <para>
|
---|
502 | <command>qmake</command>: This will build the included copy of
|
---|
503 | <application>ninja</application> if it is not already installed
|
---|
504 | and use it to configure the build.
|
---|
505 | </para>
|
---|
506 |
|
---|
507 | <para>
|
---|
508 | <command>-- -system-ffmpeg -proprietary-codecs -webengine-icu</command>: If
|
---|
509 | any options are passed to qmake they must come after '--' which must follow
|
---|
510 | '..' that points to the main directory. The options here cause it to use
|
---|
511 | system ffmpeg and system icu. The '-proprietary-codecs' option allows
|
---|
512 | ffmpeg to decode H264 and H265 codecs. If built as part of full Qt5, the
|
---|
513 | system icu is automatically used (only) by Qt5Core if it is available, but
|
---|
514 | unless this option is used webengine will always use its shipped copy of icu,
|
---|
515 | adding time and space to the build.
|
---|
516 | </para>
|
---|
517 |
|
---|
518 | <para>
|
---|
519 | <option>-webengine-jumbo-build 0</option>: If this is added to the qmake
|
---|
520 | command it will cause the 'Jumbo Build Merge Limit' to be reported as 'no'
|
---|
521 | instead of 8. That turns off the jumbo build. Some distros do that to get
|
---|
522 | a smaller build on some architectures such as MIPS. On x86_64 it might save
|
---|
523 | a little space in the build, but the build time will increase by a very
|
---|
524 | large amount.
|
---|
525 | </para>
|
---|
526 |
|
---|
527 | <para>
|
---|
528 | <option>-webengine-kerberos</option>: Add this if you have installed <xref
|
---|
529 | linkend="mitkrb"/> and wish to connect from a browser using QtWebEngine
|
---|
530 | to a webserver which requires you to connect via kerberos.
|
---|
531 | </para>
|
---|
532 |
|
---|
533 | <!--
|
---|
534 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
535 | href="../../xincludes/SIOCGSTAMP.xml"/>
|
---|
536 | -->
|
---|
537 |
|
---|
538 | <para>
|
---|
539 | <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
|
---|
540 | recognize the NINJAJOBS environment variable, this command will run system
|
---|
541 | ninja with the specified number of jobs (i.e. 4).
|
---|
542 | There are several reasons why you might want to use options like this this:
|
---|
543 | </para>
|
---|
544 |
|
---|
545 | <itemizedlist>
|
---|
546 | <listitem>
|
---|
547 | <para>
|
---|
548 | Building on a subset of CPUs allows measuring the build time
|
---|
549 | for a smaller number of processors, and/or running other
|
---|
550 | CPU-intensive tasks at the same time. For an editor on a machine
|
---|
551 | with a lot of CPUs, trying to measure the build time for a 4-CPU
|
---|
552 | machine, <option>NINJAJOBS=4 make</option> will give a reasonable
|
---|
553 | approximation (there is a short period where N+2 python and node
|
---|
554 | jobs run).
|
---|
555 | </para>
|
---|
556 | </listitem>
|
---|
557 | <listitem>
|
---|
558 | <para>
|
---|
559 | On a machine with only 4 CPUs online, the default of scheduling
|
---|
560 | N+2 jobs for qtwebengine is slower by between 3% and 7%, probably
|
---|
561 | because of the size of the C++ files and their many includes and
|
---|
562 | templates. Therefore, if in doubt set NINJAJOBS to the number of CPUs.
|
---|
563 | </para>
|
---|
564 | </listitem>
|
---|
565 | <listitem>
|
---|
566 | <para>
|
---|
567 | Reducing the number of cores being used on long running, CPU
|
---|
568 | intensive packages may alleviate heat problems.
|
---|
569 | </para>
|
---|
570 | </listitem>
|
---|
571 | <listitem>
|
---|
572 | <para>
|
---|
573 | Reducing the number of cores will prevent potential out-of-memory
|
---|
574 | problems on systems that do not have enough memory (or swap)
|
---|
575 | when all cores are active. A suggested approach is to limit
|
---|
576 | the number of cores to about one core for each 1.5 GB of
|
---|
577 | combined RAM and swap space.
|
---|
578 | </para>
|
---|
579 | </listitem>
|
---|
580 | </itemizedlist>
|
---|
581 |
|
---|
582 | </sect2>
|
---|
583 |
|
---|
584 | <sect2 role="configuration">
|
---|
585 | <title>Configuring QtWebEngine</title>
|
---|
586 |
|
---|
587 | <sect3 id="qtwebengine-config">
|
---|
588 | <title>Configuration Information</title>
|
---|
589 |
|
---|
590 | <para>
|
---|
591 | If you are upgrading from an older minor version of this
|
---|
592 | application, for some webpages to load you may need to
|
---|
593 | clear the <emphasis>browser</emphasis> caches, e.g. for
|
---|
594 | <application>falkon</application> they will be found in
|
---|
595 | <filename class="directory">~/.cache/falkon/</filename>.
|
---|
596 | You will need to do this if the browser starts to render
|
---|
597 | the page and then changes to a blank tab with a message
|
---|
598 | that something went wrong, and a button to Retry. Even
|
---|
599 | after removing the old caches, you may need to retry a
|
---|
600 | few times for each affected tab.
|
---|
601 | </para>
|
---|
602 |
|
---|
603 | <para>
|
---|
604 | If a browser using this package fails to run and when run
|
---|
605 | from a term it reports 'Trace/breakpoint trap' that is
|
---|
606 | probably a kernel configuration issue - there is no need
|
---|
607 | to rebuild QtWebEngine, see the next section, recompile
|
---|
608 | the kernel and reboot to the new kernel.
|
---|
609 | </para>
|
---|
610 |
|
---|
611 | </sect3>
|
---|
612 |
|
---|
613 | </sect2>
|
---|
614 |
|
---|
615 | <sect2 role="kernel" id="qtwebengine-kernel">
|
---|
616 | <title>Kernel Configuration</title>
|
---|
617 |
|
---|
618 | <para>
|
---|
619 | This package does not require any of the optional kernel namespace items,
|
---|
620 | but if User namespace is enabled <phrase revision="systemd">(as happens
|
---|
621 | in some unit files, for hardening)</phrase> PID namespace must also be
|
---|
622 | enabled. In that case enable the following options in the kernel
|
---|
623 | configuration and recompile the kernel if necessary:
|
---|
624 | </para>
|
---|
625 |
|
---|
626 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
627 | href="qtwebengine-kernel.xml"/>
|
---|
628 |
|
---|
629 | <indexterm zone="qtwebengine qtwebengine-kernel">
|
---|
630 | <primary sortas="d-qtwebengine">qtwebengine</primary>
|
---|
631 | </indexterm>
|
---|
632 | </sect2>
|
---|
633 |
|
---|
634 | <sect2 role="content">
|
---|
635 | <title>Contents</title>
|
---|
636 |
|
---|
637 | <segmentedlist>
|
---|
638 | <segtitle>Installed Programs</segtitle>
|
---|
639 | <segtitle>Installed Libraries</segtitle>
|
---|
640 | <segtitle>Installed Directories</segtitle>
|
---|
641 |
|
---|
642 | <seglistitem>
|
---|
643 | <seg>
|
---|
644 | qtwebengine_convert_dict and
|
---|
645 | QtWebEngineProcess (in $QT5DIR/libexec)
|
---|
646 | </seg>
|
---|
647 | <seg>
|
---|
648 | libQt5Pdf.so,
|
---|
649 | libQt5PdfWidgets.so,
|
---|
650 | libQt5WebEngineCore.so,
|
---|
651 | libQt5WebEngine.so, and
|
---|
652 | libQt5WebEngineWidgets.so
|
---|
653 | </seg>
|
---|
654 | <seg>
|
---|
655 | $QT5DIR/include/QtPdf,
|
---|
656 | $QT5DIR/include/QtPdfWidgets,
|
---|
657 | $QT5DIR/include/QtWebEngine,
|
---|
658 | $QT5DIR/include/QtWebEngineCore,
|
---|
659 | $QT5DIR/include/QtWebEngineWidgets,
|
---|
660 | $QT5DIR/qml/QtWebEngine, and
|
---|
661 | $QT5DIR/translations/qtwebengine_locales
|
---|
662 | </seg>
|
---|
663 | </seglistitem>
|
---|
664 | </segmentedlist>
|
---|
665 |
|
---|
666 | <variablelist>
|
---|
667 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
668 | <?dbfo list-presentation="list"?>
|
---|
669 | <?dbhtml list-presentation="table"?>
|
---|
670 |
|
---|
671 | <varlistentry id="qtwebengine_convert_dict">
|
---|
672 | <term><command>qtwebengine_convert_dict</command></term>
|
---|
673 | <listitem>
|
---|
674 | <para>
|
---|
675 | converts hunspell dictionaries (<literal>.dic</literal>) to chromium
|
---|
676 | format (<literal>.bdic</literal>)
|
---|
677 | </para>
|
---|
678 | <indexterm zone="qtwebengine qtwebengine_convert_dict">
|
---|
679 | <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
|
---|
680 | </indexterm>
|
---|
681 | </listitem>
|
---|
682 | </varlistentry>
|
---|
683 |
|
---|
684 | <varlistentry id="QtWebEngineProcess">
|
---|
685 | <term><command>QtWebEngineProcess</command></term>
|
---|
686 | <listitem>
|
---|
687 | <para>
|
---|
688 | is a libexec program which runs a zygote process (one that listens
|
---|
689 | for spawn requests from a master process and will fork itself in
|
---|
690 | response)
|
---|
691 | </para>
|
---|
692 | <indexterm zone="qtwebengine QtWebEngineProcess">
|
---|
693 | <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
|
---|
694 | </indexterm>
|
---|
695 | </listitem>
|
---|
696 | </varlistentry>
|
---|
697 |
|
---|
698 | <varlistentry id="libQtWebEngine-lib">
|
---|
699 | <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
|
---|
700 | <listitem>
|
---|
701 | <para>
|
---|
702 | provides QML types for rendering web content within a QML application
|
---|
703 | </para>
|
---|
704 | <indexterm zone="qtwebengine libQtWebEngine-lib">
|
---|
705 | <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
|
---|
706 | </indexterm>
|
---|
707 | </listitem>
|
---|
708 | </varlistentry>
|
---|
709 |
|
---|
710 | <varlistentry id="libQtWebEngineCore">
|
---|
711 | <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
|
---|
712 | <listitem>
|
---|
713 | <para>
|
---|
714 | provides public API shared by both QtWebEngine and QtWebEngineWidgets
|
---|
715 | </para>
|
---|
716 | <indexterm zone="qtwebengine libQtWebEngineCore">
|
---|
717 | <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
|
---|
718 | </indexterm>
|
---|
719 | </listitem>
|
---|
720 | </varlistentry>
|
---|
721 |
|
---|
722 | <varlistentry id="libQtWebEngineWidgets">
|
---|
723 | <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
|
---|
724 | <listitem>
|
---|
725 | <para>
|
---|
726 | provides a web browser engine as well as C++ classes to render and
|
---|
727 | interact with web content
|
---|
728 | </para>
|
---|
729 | <indexterm zone="qtwebengine libQtWebEngineWidgets">
|
---|
730 | <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
|
---|
731 | </indexterm>
|
---|
732 | </listitem>
|
---|
733 | </varlistentry>
|
---|
734 |
|
---|
735 | </variablelist>
|
---|
736 | </sect2>
|
---|
737 |
|
---|
738 | </sect1>
|
---|