overte-thingvellir/tools/qt-builder

General

This document describes the process to build Qt 5.12.3. Note that there are several patches.

• The first (to qfloat16.h) is needed to compile QT 5.12.3 on Visual Studio 2017 due to a bug in Visual Studio (bitset will not compile. Note that there is a change in CMakeLists.txt to support this.
• The second patch is to OpenSL ES audio and allow audio echo cancelllation on Android.
• The third is a patch to QScriptEngine to prevent crashes in QScriptEnginePrivate::reportAdditionalMemoryCost, during garbage collection. See https://bugreports.qt.io/browse/QTBUG-76176
• The fourth is a patch which fixes video playback on WebEngineViews on mac. See https://bugreports.qt.io/browse/QTBUG-70967

Requirements

Windows

1. Visual Studio 2017
   If you don’t have Community or Professional edition of Visual Studio 2017, download Visual Studio Community 2017.
   Install with C++ support.

2. python 2.7.16 Check if needed running python --version - should return python 2.7.x
   Install from https://www.python.org/ftp/python/2.7.16/python-2.7.16.amd64.msi
   Add path to python executable to PATH.

NOTE: REMOVE python 3 from PATH. Our regular build uses python 3. This will still work, because HIFI_PYTHON_EXEC points to the python 3 executable.

Verify that python runs python 2.7 (run “python --version”)

1. git >= 1.6
   Check if needed git --version
   Download from https://git-scm.com/download/win
   Verify by entering git --version
2. perl >= 5.14
   Install from Strawberry Perl - http://strawberryperl.com/ - 5.28.1.1 64 bit to C:\Strawberry\
   Verify by running perl --version
3. flex and bison
   Download from https://sourceforge.net/projects/winflexbison/files/latest/download
   Uncompress in C:\flex_bison
   Rename win-bison.exe to bison.exe and win-flex.exe to flex.exe
   Add C:\flex_bison to PATH
   Verify by running flex --version
   Verify by running bison --version
4. gperf
   Install from http://gnuwin32.sourceforge.net/downlinks/gperf.php
   Add C:\Program Files (x86)\GnuWin32\bin to PATH
   Verify by running gperf --version
5. 7-zip
   Download from https://www.7-zip.org/download.html
6. Bash shell
   From Settings select Update & Security
   Select For Developers
   Enable Developer mode
   Restart PC
   Open Control Panel and select Programs and Features
   Select Turn Windows features on or off
   Check Windows Subsystem for Linux
   Click Restart now
   Download from the Microsoft Store - Search for bash and choose the latest Ubuntu version
   [First run will take a few minutes]
   Enter a user name - all small letters (this is used for sudo commands)
   Choose a password
7. Jom
   jom is a clone of nmake to support the execution of multiple independent commands in parallel.
   https://wiki.qt.io/Jom

Linux

Tested on Ubuntu 16.04 and 18.04.
**16.04 NEEDED FOR JENKINS~~ **

1. qt5 requirements
   edit /etc/apt/sources.list (edit as root)
   replace all # deb-src with deb-src (in vi 1,$s/# deb-src/deb-src/)
   sudo apt-get update -y
sudo apt-get upgrade -y
sudo apt-get build-dep qt5-default -y
2. git >= 1.6
   Check if needed git --version
sudo apt-get install git -y
   Verify again
3. python
   Check if needed python --version - should return python 2.7.x
   sudo apt-get install python -y (not python 3!)
   Verify again
4. gperf
   Check if needed gperf --version
sudo apt-get install gperf -y
   Verify again
5. bison and flex
   Check if needed flex --version and bison --version
sudo apt-get install flex bison -y
   Verify again
6. pkg-config (needed for qtwebengine)
   Check if needed pkg-config --version
sudo apt-get install pkg-config -y
   Verify again
7. OpenGL
   Verify (first install mesa-utils - sudo apt install mesa-utils -y) by glxinfo | grep "OpenGL version"
sudo apt-get install libgl1-mesa-dev -y
sudo ln -s /usr/lib/x86_64-linux-gnu/libGL.so.346.35 /usr/lib/x86_64-linux-gnu/libGL.so.1.2.0
   Verify again
8. make
   Check if needed make --version
sudo apt-get install make -y
   Verify again
9. g++
   Check if needed
   g++ --version
sudo apt-get install g++ -y
   Verify again
10. dbus-1 (needed for qtwebengine)
    sudo apt-get install libdbus-glib-1-dev -y
11. nss (needed for qtwebengine)
    sudo apt-get install libnss3-dev -y

Mac

1. git >= 1.6
   Check if needed git --version
   Install from https://git-scm.com/download/mac
   Verify again
2. pkg-config
   brew fontconfig dbus-glib stall pkg-config
3. dbus-1
   brew install dbus-glib

Build Process

General

qt is cloned to the qt5 folder.
The build is performed in the qt5-build folder.
Build products are installed to the qt5-install folder.
Before running configure, make sure that the qt5-build folder is empty.

Only run the git patches once!!!

Windows

Before building, verify that HIFI_VCPKG_BASE_VERSION points to a vcpkg folder containing packages\openssl-windows_x64-windows.
If not, follow https://github.com/highfidelity/vcpkg to install vcpkg and then openssl. Also, make sure the directory that you are using to build qt is not deeply nested. It is quite possible to run into the windows MAX_PATH limit when building chromium. For example: c:\msys64\home\ajt\code\hifi\tools\qt-builder\qt5-build is too long. c:\q\qt5-build\ is a better choice.

Preparing source files

git clone --recursive https://code.qt.io/qt/qt5.git -b 5.12.3 --single-branch

• Copy the patches folder to qt5
• Copy the qt5vars.bat file to qt5
• Apply the patches to Qt

cd qt5
git apply --ignore-space-change --ignore-whitespace patches/qfloat16.patch
git apply --ignore-space-change --ignore-whitespace patches/aec.patch
git apply --ignore-space-change --ignore-whitespace patches/qtscript-crash-fix.patch
cd ..

Configuring

mkdir qt5-install
mkdir qt5-build
cd qt5-build

run ..\qt5\qt5vars.bat
cd ..\..\qt5-build

..\qt5\configure -force-debug-info -opensource -confirm-license -opengl desktop -platform win32-msvc -openssl-linked OPENSSL_LIBS="-lssleay32 -llibeay32" -I %HIFI_VCPKG_BASE_VERSION%\packages\openssl-windows_x64-windows\include -L %HIFI_VCPKG_BASE_VERSION%\packages\openssl-windows_x64-windows\lib -nomake examples -nomake tests -skip qttranslations -skip qtserialport -skip qt3d -skip qtlocation -skip qtwayland -skip qtsensors -skip qtgamepad -skip qtspeech -skip qtcharts -skip qtx11extras -skip qtmacextras -skip qtvirtualkeyboard -skip qtpurchasing -skip qtdatavis3d -no-warnings-are-errors -no-pch -prefix ..\qt5-install

Make

jom
jom install

Fixing

The .prl files have an absolute path that needs to be removed (see http://www.linuxfromscratch.org/blfs/view/stable-systemd/x/qtwebengine.html)

1. Open a bash terminal
2. cd to the qt5-install folder (e.g. cd /mnt/d/qt5-install/)
3. Run the following command
   find . -name \*.prl -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;
4. Copy qt.conf to qt5-install\bin

Uploading

Create a tar file called qt5-install-5.12.3-windows.tar.gz from the qt5-install folder. Upload qt5-install-5.12.3-windows.tar.gz to our Amazon S3 hifi-public bucket, under the dependencies/vckpg directory. Update hifi_vcpkg.py to use this new URL. Additionally, you should make a small change to any file in the hifi/cmake/ports directory to force the re-download of the qt-install.tar.gz during the build process for hifi.

Preparing Symbols

Run python3 prepare-windows-symbols-for-backtrace.py qt5-install to scan the qt5-install directory for any dlls and pdbs. After running this command the backtrace directory will be created. Zip this directory up, but make sure that all dlls and pdbs are in the root of the zip file, not under a sub-directory. This file can then be uploaded to backtrace here: https://highfidelity.sp.backtrace.io/p/Interface/settings/symbol/upload

Linux

Preparing source files

git clone --recursive git://code.qt.io/qt/qt5.git -b 5.12.3 --single-branch

• Copy the patches folder to qt5
• Apply patches to Qt
  cd qt5
git apply --ignore-space-change --ignore-whitespace patches/aec.patch
git apply --ignore-space-change --ignore-whitespace patches/qtscript-crash-fix.patch
cd ..

Configuring

mkdir qt5-install
mkdir qt5-build
cd qt5-build

Ubuntu 16.04
../qt5/configure -opensource -confirm-license -platform linux-g++-64 -qt-zlib -qt-libjpeg -qt-libpng -qt-xcb -qt-freetype -qt-pcre -qt-harfbuzz -nomake examples -nomake tests -skip qttranslations -skip qtserialport -skip qt3d -skip qtlocation -skip qtwayland -skip qtsensors -skip qtgamepad -skip qtspeech -skip qtcharts -skip qtmacextras -skip qtvirtualkeyboard -skip qtpurchasing -skip qtdatavis3d -no-warnings-are-errors -no-pch -no-egl -no-icu -prefix ../qt5-install

Ubuntu 18.04
../qt5/configure -force-debug-info -release -opensource -confirm-license -gdb-index -recheck-all -nomake tests -nomake examples -skip qttranslations -skip qtserialport -skip qt3d -skip qtlocation -skip qtwayland -skip qtsensors -skip qtgamepad -skip qtspeech -skip qtcharts -skip qtx11extras -skip qtmacextras -skip qtvirtualkeyboard -skip qtpurchasing -skip qtdatavis3d -no-warnings-are-errors -no-pch -c++std c++14 -prefix ../qt5-install

???../qt5/configure -opensource -confirm-license -gdb-index -nomake examples -nomake tests -skip qttranslations -skip qtserialport -skip qt3d -skip qtlocation -skip qtwayland -skip qtsensors -skip qtgamepad -skip qtspeech -skip qtcharts -skip qtmacextras -skip qtvirtualkeyboard -skip qtpurchasing -skip qtdatavis3d -no-warnings-are-errors -no-pch -prefix ../qt5-install

Make

make

????Ubuntu 18.04 only
????make module-qtwebengine
????make module-qtscript

Both
make install

Fixing

1. The .prl files have an absolute path that needs to be removed (see http://www.linuxfromscratch.org/blfs/view/stable-systemd/x/qtwebengine.html)
   cd ../qt5-install
find . -name \*.prl -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;
2. Copy qt.conf to qt5-install\bin

Uploading

Ubuntu 16.04

1. Return to the home folder
   cd ..
2. Open a python 3 shell
   python3
3. Run the following snippet:
   import os
import tarfile
filename=tarfile.open("qt5-install.tar.gz", "w:gz")
filename.add("qt5-install", os.path.basename("qt5-install"))
exit()
4. Upload qt5-install.tar.gz to https://hifi-qa.s3.amazonaws.com/qt5/Ubuntu/16.04

Ubuntu 18.04
``tar -zcvf qt5-install.tar.gz qt5-install`

1. Upload qt5-install.tar.gz to https://hifi-qa.s3.amazonaws.com/qt5/Ubuntu/18.04

Mac

Preparing source files

git clone --recursive git://code.qt.io/qt/qt5.git -b 5.12.3 --single-branch

• Copy the patches folder to qt5
• Apply the patches to Qt
  cd qt5
git apply --ignore-space-change --ignore-whitespace patches/aec.patch
git apply --ignore-space-change --ignore-whitespace patches/qtscript-crash-fix.patch
git apply --ignore-space-change --ignore-whitespace patches/mac-web-video.patch
cd ..

Configuring

mkdir qt5-install
mkdir qt5-build
cd ../qt5-build

../qt5/configure -force-debug-info -opensource -confirm-license -qt-zlib -qt-libjpeg -qt-libpng -qt-freetype -qt-pcre -qt-harfbuzz -nomake examples -nomake tests -skip qttranslations -skip qtserialport -skip qt3d -skip qtlocation -skip qtwayland -skip qtsensors -skip qtgamepad -skip qtspeech -skip qtcharts -skip qtx11extras -skip qtmacextras -skip qtvirtualkeyboard -skip qtpurchasing -skip qtdatavis3d -no-warnings-are-errors -no-pch -prefix ../qt5-install

Make

make
make install

Fixing

1. The .prl files have an absolute path that needs to be removed (see http://www.linuxfromscratch.org/blfs/view/stable-systemd/x/qtwebengine.html)
   cd ../qt5-install
find . -name \*.prl -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;
cd ..
2. Copy qt.conf to qt5-install\bin

Uploading

tar -zcvf qt5-install-5.13.2-macos.tar.gz qt5-install
Upload qt5-install-5.13.2-macos.tar.gz to our Amazon S3 hifi-public bucket, under the dependencies/vckpg directory

Creating symbols

Run python3 prepare-mac-symbols-for-backtrace.py qt5-install to scan the qt5-build directory for any dylibs and execute dsymutil to create dSYM bundles. After running this command the backtrace directory will be created. Zip this directory up, but make sure that all dylibs and dSYM fiels are in the root of the zip file, not under a sub-directory. This file can then be uploaded to backtrace here: https://highfidelity.sp.backtrace.io/p/Interface/settings/symbol/upload

Problems

configure errors, if any, may be viewed in config.log and config.summary