QtWebEngine/Qt6Build: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
m (improve introduction)
m (remove extra 'skip webengine')
 
(5 intermediate revisions by the same user not shown)
Line 31: Line 31:
==Obtain the Qt6 source code==
==Obtain the Qt6 source code==


Select the location for the source code and checkout the source:
Select the location for the source code and checkout the qt6 source:
 
Starting with Qt 6.8 you can simply clone qt5 repository and call 'init-repository' cmake script.


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
git clone git://code.qt.io/qt/qt5.git qt6
git clone git://code.qt.io/qt/qt5.git qt6
cd qt6
init-repository --module-subset=qtbase,qtshadertools,qtdeclarative,qtwebengine --no-resolve-deps
</syntaxhighlight>
</syntaxhighlight>


{{note|On Windows platform you should use 'init-repository.bat' instead of 'init-repository' command.}}
==Select branch==


QtWebEngine needs initialization of the submodule:
Let's assume we want to compile latest Qt 6.8.


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
cd qtwebenigne
cd qt6
git submodule init
git checkout origin/6.8
git submodule update
cd ..
</syntaxhighlight>
</syntaxhighlight>


==Select branches==
==Initialize all required modules==


Let's assume we want to compile Qt 6.2.4 with Qt WebEngine 6.4.3
Starting with Qt 6.8 you can simply after cloning qt5 repository and selecting branch call 'init-repository' cmake script. This will also setup all the required submodules.  
Therefore, in qtbase, qtshadertools, qtdeclarative repositories we select branches:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
git checkout origin/6.2.4
./init-repository --module-subset=qtbase,qtshadertools,qtdeclarative,qtwebengine --no-resolve-deps
</syntaxhighlight>
</syntaxhighlight>


Where-else in qtwebengine
{{note|On Windows platform you should use 'init-repository.bat' instead of 'init-repository' command.}}
 
<syntaxhighlight lang="bash">
cd qtwebengine
git checkout origin/6.4.3
git submodule update
cd ..
</syntaxhighlight>


==Shadow build==
==Shadow build==


It is a common practice to compile the project in separate build directory instead of doing in-source build, therefore we create the following build layout:
It is a common practice to compile the project in separate build directory instead of doing in-source build, therefore we create build directory:


{{note|On Windows platform you should use 'md' instead of 'mkdir' command}}
{{note|On Windows platform you should use 'md' instead of 'mkdir' command}}
Line 79: Line 65:
mkdir build
mkdir build
cd build
cd build
mkdir qtbase qtshadertools qtdeclarative qtwebengine
</syntaxhighlight>
</syntaxhighlight>


==Configure and build qtbase==
==Configure top level build and build required submodules==


From our qtbase 'build' directory we call the configure from qtbase 'source' directory to make prefix build, which means that we will compile and than install to the specific installation directory defined with 'prefix' argument.
From our 'build' directory we call the configure from qt6 'source' directory to make prefix build, which means that we will compile and than install to the specific installation directory defined with 'prefix' argument.
   
   
On '''Linux''' the configure command line for the release builds with xcb might look like:
{{note|We will add '-skip qtwebengine' argument to configure call as we want to do qtwebenigne build separately.}}
 
On '''Linux''' the configure command line for the release builds might look like:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
cd build/qtbase
 
../../qtbase/configure -opensource -confirm-license -release -nomake tests -nomake examples -xcb -opengl desktop -qpa xcb -no-pch -linker lld -prefix /opt/qt/6.2
../configure -release -nomake tests -nomake examples -no-pch -linker mold -skip qtwebengine -prefix /opt/qt/6.8
</syntaxhighlight>
</syntaxhighlight>


{{note|To speed up linking time for WebEngine we decided to use lld linker.}}
{{note|To speed up linking time for WebEngine we decided to use mold linker.}}


On '''Windows''' the configure command line for the release build with debug info might look like:
On '''Windows''' the configure command line for the release build might look like:


<syntaxhighlight>
<syntaxhighlight>
cd build\qtbase
..\configure.bat -release -nomake tests -nomake examples -no-pch -skip qtwebengine -prefix C:\opt\qt\6.8
..\..\qtbase\configure.bat -opensource -confirm-license -release -force-debug-info -nomake tests -nomake examples -prefix C:\opt\qt\6.2
</syntaxhighlight>
</syntaxhighlight>


Line 105: Line 91:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
cd build/qtbase
../configure -release -framework -release -nomake tests -nomake examples -no-pch -skip qtwebengine -prefix /opt/qt/6.8
../../qtbase/configure -developer-build -nomake examples -release -force-debug-info -separate-debug-info -framework -prefix /opt/qt/6.2
</syntaxhighlight>
</syntaxhighlight>


Line 112: Line 97:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
cd build/qtbase
../configure -release -framework -nomake tests -nomake examples -no-pch -skip qtwebengine -prefix /opt/qt/6.8 -- -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64"
../../qtbase/configure -nomake examples -release -force-debug-info -separate-debug-info -framework -prefix /opt/qt/6.2 -- -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64"
</syntaxhighlight>
</syntaxhighlight>


{{note| For other configure options please refer to the configure guide https://doc.qt.io/qt-6/configure-options.html}}
{{note| For other configure options please refer to the configure guide https://doc.qt.io/qt-6/configure-options.html}}


To build and install qt base you just need to call cmake:
To build and install modules you just need to call cmake:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Line 127: Line 111:
{{note | On Windows in case of debug and release build please use "ninja install" instead of "cmake --install ." due to cmake [https://gitlab.kitware.com/cmake/cmake/-/issues/21475 issue]}}
{{note | On Windows in case of debug and release build please use "ninja install" instead of "cmake --install ." due to cmake [https://gitlab.kitware.com/cmake/cmake/-/issues/21475 issue]}}


==Configure and build other modules==
==Configure and build QtWebEngine module==


To configure and build other modules we use the '''qt-configure-module wrapper''' script from the installed qtbase module.
To configure and build QtWebEngine module we use the '''qt-configure-module wrapper''' script from the installed in previous step Qt.


{{note|On Windows you might want to call 'C:\opt\qt\6.2\bin\qt-cofigure-module.bat' instead of 'qt-cofigure-module'}}
{{note|On Windows you might want to call 'C:\opt\qt\6.8\bin\qt-cofigure-module.bat' instead of 'qt-cofigure-module'}}


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
cd build/qtshadertools
mkdir qtwebengine
/opt/qt/6.2/bin/qt-configure-module ../../qtshadertools
cmake --build . --parallel
cmake --install .
cd ..
 
cd qtdeclarative
/opt/qt/6.2/bin/qt-configure-module ../../qtdeclarative
cmake --build . --parallel
cmake --install .
cd ..
 
cd qtwebengine
cd qtwebengine
/opt/qt/6.2/bin/qt-configure-module ../../qtwebengine
/opt/qt/6.8/bin/qt-configure-module ../../qtwebengine
cmake --build . --parallel
cmake --build . --parallel
cmake --install .
cmake --install .
cd ..
cd ..
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 12:44, 16 September 2025

Building Qt6 WebEngine from Source

Please check platform notes for required dependencies https://doc.qt.io/qt-6/qtwebengine-platform-notes.html.

Qt builds can be done in top level manner, meaning that you clone qt5 main repository (git://code.qt.io/qt/qt5.git), which then initializes all the qt modules as sub-modules, configures all the modules and builds everything in one go. However, there is also the alternative way, so called module build, which is more robust as it configures, builds and installs each qt module separately.

This guide uses both approaches, first it clones minimum subset of modules required for QtWebEngine and compiles all modules required for webengine build in top level manner. Then it builds webengine module separately, so we are able to focus on webenigne build issues only.

  Note: Compiling each module separately has advantage that you can see configure and compilation issues just for given module, meaning that you can install missing dependencies and just reconfigure and recompile the problematic module instead of rerunning configuration for all modules.

Open the build shell

All the build commands we execute in a build shell / terminal.

On Windows platform Developer Command Prompt is required, therefore for example for Visual Studio Build Tools 2022 the correct setup requires:

call "C:\Program File (x86)\Microsoft Visial Studio\2022\BuildTools\VC\Auxilary\Build\vcvarsall.bat" amd64

  Note: The location of the script may vary please refer to the Microsoft documentation.

Obtain the Qt6 source code

Select the location for the source code and checkout the qt6 source:

git clone git://code.qt.io/qt/qt5.git qt6

Select branch

Let's assume we want to compile latest Qt 6.8.

cd qt6
git checkout origin/6.8

Initialize all required modules

Starting with Qt 6.8 you can simply after cloning qt5 repository and selecting branch call 'init-repository' cmake script. This will also setup all the required submodules.

./init-repository --module-subset=qtbase,qtshadertools,qtdeclarative,qtwebengine --no-resolve-deps

  Note: On Windows platform you should use 'init-repository.bat' instead of 'init-repository' command.

Shadow build

It is a common practice to compile the project in separate build directory instead of doing in-source build, therefore we create build directory:

  Note: On Windows platform you should use 'md' instead of 'mkdir' command

mkdir build
cd build

Configure top level build and build required submodules

From our 'build' directory we call the configure from qt6 'source' directory to make prefix build, which means that we will compile and than install to the specific installation directory defined with 'prefix' argument.

  Note: We will add '-skip qtwebengine' argument to configure call as we want to do qtwebenigne build separately.

On Linux the configure command line for the release builds might look like:

../configure -release -nomake tests -nomake examples -no-pch -linker mold -skip qtwebengine -prefix /opt/qt/6.8

  Note: To speed up linking time for WebEngine we decided to use mold linker.

On Windows the configure command line for the release build might look like:

..\configure.bat -release -nomake tests -nomake examples -no-pch -skip qtwebengine -prefix C:\opt\qt\6.8

On Mac the configure command line for the release framework builds might look like:

../configure -release -framework -release -nomake tests -nomake examples -no-pch -skip qtwebengine -prefix /opt/qt/6.8

or Mac universal build :

../configure -release -framework -nomake tests -nomake examples -no-pch -skip qtwebengine -prefix /opt/qt/6.8 -- -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64"

  Note: For other configure options please refer to the configure guide https://doc.qt.io/qt-6/configure-options.html

To build and install modules you just need to call cmake:

cmake --build . --parallel
cmake --install .

  Note: On Windows in case of debug and release build please use "ninja install" instead of "cmake --install ." due to cmake issue

Configure and build QtWebEngine module

To configure and build QtWebEngine module we use the qt-configure-module wrapper script from the installed in previous step Qt.

  Note: On Windows you might want to call 'C:\opt\qt\6.8\bin\qt-cofigure-module.bat' instead of 'qt-cofigure-module'

mkdir qtwebengine
cd qtwebengine
/opt/qt/6.8/bin/qt-configure-module ../../qtwebengine
cmake --build . --parallel
cmake --install .
cd ..