jschultz / kde-static

Patches and scripts to build KDE statically for Linux and crossbuild for Windows

I've been looking for a simple way to make my work-in-progress project okular-tagging available to others in the simplest way possible for users who have no interest or ability in installing or building packages. One option that has always attacted me is a static build as it eliminates in one stroke all the problems associated with runtime library dependencies.

This repository represents the results of my on-and-off efforts over some time to build KDE frameworks and the non-trivial application okular statically.

Somewhat to my surprise it turned out not to be too complicated. Although the patches to the KDE sources are quite long, the vast bulk of them are simple changes to cmake files to enable static libraries. The biggest hurdle was turning okular's generator plugins into static libraries, which involved a bit (but not too much) hackery. The end result is a series of patches to KDE sources that work not only for static and conventional dynamic building, but also cross-building for MingW using the excellent MXE framework.

If you just want to take a look at what I did to KDE, it's all in patch-kde.sh.

The whole thing is done using Docker containers based on the voidlinux distro using musl libraries, but since the final output is a statically linked executable it should run on pretty much any Linux distribution. The mingw executable runs under wine or Windows.

How to build KDE frameworks and okular statically

To build KDE frameworks plus okular statically, you'll need to start by downloading the KDE sources. The best way to do this is to use kdesrc-build. The configuration file kdesrc-buildrc-sources downloads frameworks revision v5.54.0 and okular revision 18.12. Currently hard-coded, the KDE sources need to be loaded under ~/src/kde/source.

Having downloaded the KDE sources you need to apply the patches to enable them to be build statically. You can do this by invoking the script patch-kde.sh from the directory in which the sources were downloaded (ie ~/src/kde/source).

You can now start the build process by running kde-static.sh from the repository directory.

How it works

The process begins by building the proot library, which owing to an upstream release issue, does not work correctly on modern kernels in its stock release. This creates an initial docker image named voidlinux/build.

It then creates a second docker image named voidlinux/kde-static. This image contains all the prerequisites for building KDE:

• Packages that need to be build specially to get static libraries.
• qt5, qtwebkit, libaccounts, signond
• kdesrc-build

Finally the build script launches a conainer kde-static to build frameworks and okular using the stock kdesrc-build script. When it is finished the results can be extracted from the container, directory /home/kdedev/kde/install [TODO: Make this directory a volume]

The results

The final okular executable is around 85MB in size, which seems pretty reasonable to me for such a large application. Apparently by using Link-Time Optimization (LTO) this could be reduced by up to 80%.

Other things

Since my internet connection is the end of the proverbial wet piece of string, I have done a few things to reduce net traffic. These shouldn't affect someone who isn't worried about these things, but you are, or if they cause problems, then note that:

1. http_proxy, https_proxy and ftp_proxy are all inherited into docker images and containers
2. The environment variable certificate can contain the name of a file inside the build context (ie the repository root) that contains a certificate that will be loaded into the docker image. This allows proxying of https connections by, for example, squid, which acts as a 'man in the middle' on secure net connections, so that the client sees connections signed with a different certificate.

Similar scripts kde-dynamic.sh and ming.sh build KDE frameworks and okular dynamically and cross-built for MingW32 respectively. Note that several frameworks modules fail to build for MingW32, but okular can nonetheless be build successfully. It almost runs, but seems to have some problems finding and translating menu items. [TODO: fix this]

kde-static's Issues

Building proot in VoidLinux container fails

My internet connection is fixed, so the checksum mismatch can't derive from partial downloads or similar.

=> proot-5.1.0_5: removing autodeps, please wait...
=> proot-5.1.0_5: building ...
   [target] libarchive-devel-3.3.3_3: found (/host/binpkgs)
   [target] talloc-devel-2.1.14_1: found (https://alpha.de.repo.voidlinux.org/current/musl)
=> proot-5.1.0_5: installing target dependency 'libarchive-devel-3.3.3_3' ...
=> proot-5.1.0_5: installing target dependency 'talloc-devel-2.1.14_1' ...
=> proot-5.1.0_5: running do-fetch hook: 00-distfiles ...
=> proot-5.1.0_5: fetching distfile 'v5.1.0.tar.gz'...
looking up github.com
connecting to github.com:443
SSL options: 4004
Peer verification enabled
Using CA cert path: /etc/ssl/certs
Verify hostname
TLSv1.2 connection established using ECDHE-RSA-AES128-GCM-SHA256
Certificate subject: /businessCategory=Private Organization/jurisdictionCountryName=US/jurisdictionStateOrProvinceName=Delaware/serialNumber=5157550/C=US/ST=California/L=San Francisco/O=GitHub, Inc./CN=github.com
Certificate issuer: /C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert SHA2 Extended Validation Server CA
requesting https://github.com/proot-me/PRoot/archive/v5.1.0.tar.gz
302 redirect to https://codeload.github.com/proot-me/proot/tar.gz/v5.1.0
looking up codeload.github.com
connecting to codeload.github.com:443
SSL options: 4004
Peer verification enabled
Using CA cert path: /etc/ssl/certs
Verify hostname
TLSv1.2 connection established using ECDHE-RSA-AES128-GCM-SHA256
Certificate subject: /C=US/ST=California/L=San Francisco/O=GitHub, Inc./CN=*.github.com
Certificate issuer: /C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert SHA2 High Assurance Server CA
requesting https://codeload.github.com/proot-me/proot/tar.gz/v5.1.0
v5.1.0.tar.gz: [0B 0%] 312KB/s ETA: unknown
v5.1.0.tar.gz: [0B 0%] 114KB/s ETA: unknown
v5.1.0.tar.gz: 247KB [avg rate: 2356KB/s]
=> proot-5.1.0_5: verifying checksum for distfile 'v5.1.0.tar.gz'... 
=> ERROR: SHA256 mismatch for 'v5.1.0.tar.gz:'
ce0a3baca8312613bd10f65bb436a3aaa28e1034f498a22c35ad0693600e01dd
=> ERROR: proot-5.1.0_5: couldn't verify distfiles, exiting...

xz missing from build container?

Is it possible, that the xz command is missing from build container?

Step 52/62 : RUN wget -qO- http://download.qt.io/official_releases/qt/5.11/5.11.3/single/qt-everywhere-src-5.11.3.tar.xz | tar xJ && 	patch -d ~/qt-everywhere-src-5.11.3 -p0 < ~/qt.musl.patch && 	wget -qO- https://raw.githubusercontent.com/gentoo/libressl/master/dev-qt/qtnetwork/files/qtnetwork-5.11.3-libressl-2.8.patch | patch -d ~/qt-everywhere-src-5.11.3/qtbase -p1 && 	mv ~/config.opt ~/qt-everywhere-src-5.11.3 && 	cd ~/qt-everywhere-src-5.11.3 && ./configure -redo && make -j4 -Oline && make -j4 install && 	cd ~ && rm -r ~/qt-everywhere-src-5.11.3 && 	export PATH=/home/kdedev/qt-everywhere-5.11.3/bin:$PATH && 	wget -qO- http://download.qt.io/snapshots/ci/qtwebkit/5.212/1515668564/src/submodules/qtwebkit-everywhere-src-5.212.tar.xz | tar xJ && 	cd qtwebkit-everywhere-src-5.212 &&     cmake -DPORT=Qt -DCMAKE_BUILD_TYPE=Release -DQt5_DIR=/home/kdedev/qt-everywhere-5.11.3 -DCMAKE_PREFIX_PATH=/home/kdedev/qt-everywhere-5.11.3/lib/cmake -DCMAKE_INSTALL_PREFIX=/home/kdedev/qt-everywhere-5.11.3 -DENABLE_SAMPLING_PROFILER=0 -DUSE_THIN_ARCHIVES=OFF &&     make -j4 && make -j4 install &&     cd ~ && rm -r ~/qtwebkit-everywhere-src-5.212 && 	wget -qO- https://gitlab.com/accounts-sso/libaccounts-qt/-/archive/master/libaccounts-qt-master.tar.gz | tar xz &&	cd ~/libaccounts-qt-master &&     patch -p0 < /home/kdedev/libaccounts.patch &&     qmake PREFIX=/home/kdedev/qt-everywhere-5.11.3 &&     make -j4 -Oline && make -j4 install &&     cd ~ && rm -r ~/libaccounts-qt-master && 	wget -qO- https://gitlab.com/accounts-sso/signond/-/archive/master/signond-master.tar.gz | tar xz && 	cd ~/signond-master &&     patch -p0 < /home/kdedev/signon.patch &&     qmake PREFIX=/home/kdedev/qt-everywhere-5.11.3 &&     make -j4 -Oline && make -j4 install &&     cd ~ && rm -r ~/signond-master
 ---> Running in 3545c6dba264
**xz: (stdin): File format not recognized
tar: Child returned status 1
tar: Error is not recoverable: exiting now**
The command '/bin/sh -c wget -qO- http://download.qt.io/official_releases/qt/5.11/5.11.3/single/qt-everywhere-src-5.11.3.tar.xz | tar xJ && 	patch -d ~/qt-everywhere-src-5.11.3 -p0 < ~/qt.musl.patch && 	wget -qO- https://raw.githubusercontent.com/gentoo/libressl/master/dev-qt/qtnetwork/files/qtnetwork-5.11.3-libressl-2.8.patch | patch -d ~/qt-everywhere-src-5.11.3/qtbase -p1 && 	mv ~/config.opt ~/qt-everywhere-src-5.11.3 && 	cd ~/qt-everywhere-src-5.11.3 && ./configure -redo && make -j4 -Oline && make -j4 install && 	cd ~ && rm -r ~/qt-everywhere-src-5.11.3 && 	export PATH=/home/kdedev/qt-everywhere-5.11.3/bin:$PATH && 	wget -qO- http://download.qt.io/snapshots/ci/qtwebkit/5.212/1515668564/src/submodules/qtwebkit-everywhere-src-5.212.tar.xz | tar xJ && 	cd qtwebkit-everywhere-src-5.212 &&     cmake -DPORT=Qt -DCMAKE_BUILD_TYPE=Release -DQt5_DIR=/home/kdedev/qt-everywhere-5.11.3 -DCMAKE_PREFIX_PATH=/home/kdedev/qt-everywhere-5.11.3/lib/cmake -DCMAKE_INSTALL_PREFIX=/home/kdedev/qt-everywhere-5.11.3 -DENABLE_SAMPLING_PROFILER=0 -DUSE_THIN_ARCHIVES=OFF &&     make -j4 && make -j4 install &&     cd ~ && rm -r ~/qtwebkit-everywhere-src-5.212 && 	wget -qO- https://gitlab.com/accounts-sso/libaccounts-qt/-/archive/master/libaccounts-qt-master.tar.gz | tar xz &&	cd ~/libaccounts-qt-master &&     patch -p0 < /home/kdedev/libaccounts.patch &&     qmake PREFIX=/home/kdedev/qt-everywhere-5.11.3 &&     make -j4 -Oline && make -j4 install &&     cd ~ && rm -r ~/libaccounts-qt-master && 	wget -qO- https://gitlab.com/accounts-sso/signond/-/archive/master/signond-master.tar.gz | tar xz && 	cd ~/signond-master &&     patch -p0 < /home/kdedev/signon.patch &&     qmake PREFIX=/home/kdedev/qt-everywhere-5.11.3 &&     make -j4 -Oline && make -j4 install &&     cd ~ && rm -r ~/signond-master' returned a non-zero code: 2

Compilation of signond-master fails

make[3]: Entering directory '/home/kdedev/signond-master/lib/SignOn'
rm -f libsignon-qt5.so.1.0.0 libsignon-qt5.so libsignon-qt5.so.1 libsignon-qt5.so.1.0
make[3]: Leaving directory '/home/kdedev/signond-master/lib/SignOn'
make[3]: Entering directory '/home/kdedev/signond-master/lib/SignOn'
g++ -Wl,-O1 -Wl,--gc-sections -shared -Wl,-soname,libsignon-qt5.so.1 -o libsignon-qt5.so.1.0.0 identityinfo.o async-dbus-proxy.o authservice.o authserviceimpl.o authsession.o authsessionimpl.o connection-manager.o dbusinterface.o debug.o identity.o identityimpl.o identityinfoimpl.o securitycontext.o moc_authservice.o moc_identity.o moc_authsession.o moc_signonerror.o moc_authserviceimpl.o moc_async-dbus-proxy.o moc_authsessionimpl.o moc_connection-manager.o moc_identityimpl.o /home/kdedev/qt-everywhere-5.12.4/lib/libQt5DBus.a /usr/lib/libdbus-1.so /home/kdedev/qt-everywhere-5.12.4/lib/libQt5Core.a -lexecinfo -lm /usr/lib/libicui18n.so /usr/lib/libicuuc.so /usr/lib/libicudata.so /home/kdedev/qt-everywhere-5.12.4/lib/libqtpcre2.a /usr/lib/libgthread-2.0.so /usr/lib/libglib-2.0.so -lpthread -lWebCore -lJavaScriptCore -lWTF -lxml2 -lsqlite3 -lz -ljpeg -lpng -lbmalloc -lxslt -lhyphen -lwoff2 -lbrotli
make[3]: Leaving directory '/home/kdedev/signond-master/lib/SignOn'
/usr/sbin/ld: cannot find -lWebCore
/usr/sbin/ld: cannot find -lJavaScriptCore
/usr/sbin/ld: cannot find -lWTF
/usr/sbin/ld: cannot find -lbmalloc
/usr/sbin/ld: cannot find -lwoff2
/usr/sbin/ld: cannot find -lbrotli
collect2: error: ld returned 1 exit status
make[3]: *** [Makefile.libsignon-qt-shared:151: libsignon-qt5.so.1.0.0] Error 1
make[2]: *** [Makefile:45: sub-libsignon-qt-shared-pro-make_first-ordered] Error 2
make[1]: *** [Makefile:74: sub-SignOn-make_first] Error 2
make: *** [Makefile:47: sub-lib-make_first] Error 2
The command '/bin/sh -c wget -qO- http://download.qt.io/official_releases/qt/5.12/5.12.4/single/qt-everywhere-src-5.12.4.tar.xz | tar xJ && patch -d ~/qt-everywhere-src-5.12.4 -p0 < ~/qt.musl.patch && patch -d ~/qt-everywhere-src-5.12.4/qtbase -p1 < qtnetwork-5.12.4-libressl.patch && mv ~/config.opt ~/qt-everywhere-src-5.12.4 && cd ~/qt-everywhere-src-5.12.4 && ./configure -redo && make -j4 -Oline && make -j4 install && cd ~ && rm -r ~/qt-everywhere-src-5.12.4 && export PATH=/home/kdedev/qt-everywhere-5.12.4/bin:$PATH && wget -qO- http://download.qt.io/snapshots/ci/qtwebkit/5.212/1515668564/src/submodules/qtwebkit-everywhere-src-5.212.tar.xz | tar xJ && cd qtwebkit-everywhere-src-5.212 && cmake -DPORT=Qt -DCMAKE_BUILD_TYPE=Release -DQt5_DIR=/home/kdedev/qt-everywhere-5.12.4 -DCMAKE_PREFIX_PATH=/home/kdedev/qt-everywhere-5.12.4/lib/cmake -DCMAKE_INSTALL_PREFIX=/home/kdedev/qt-everywhere-5.12.4 -DENABLE_SAMPLING_PROFILER=0 -DUSE_THIN_ARCHIVES=OFF && make -j4 && make -j4 install && cd ~ && rm -r ~/qtwebkit-everywhere-src-5.212 && wget -qO- https://gitlab.com/accounts-sso/libaccounts-qt/-/archive/master/libaccounts-qt-master.tar.gz | tar xz && cd ~/libaccounts-qt-master && patch -p0 < /home/kdedev/libaccounts.patch && qmake PREFIX=/home/kdedev/qt-everywhere-5.12.4 && make -j4 -Oline && make -j4 install && cd ~ && rm -r ~/libaccounts-qt-master && wget -qO- https://gitlab.com/accounts-sso/signond/-/archive/master/signond-master.tar.gz | tar xz && cd ~/signond-master && patch -p0 < /home/kdedev/signon.patch && qmake PREFIX=/home/kdedev/qt-everywhere-5.12.4 && make -j4 -Oline && make -j4 install && cd ~ && rm -r ~/signond-master' returned a non-zero code: 2