Difference between revisions of "Guidelines and HOWTOs/Build from source"

Jump to: navigation, search
(Editor)
(Make the Testing Plasma link go do the main Development page)
 
(169 intermediate revisions by 28 users not shown)
Line 1: Line 1:
= Build requirements =
+
= Build KDE Frameworks and Applications =
This section provides information about '''hard''' (required) and '''optional''' software packages needed to build the KDE Framework.
 
  
=== Dependencies ===
+
== Design features ==
*'''deb-based distributions (Debian, Kubuntu...):'''
+
Qt and most KDE software are written in C++ whereas its "competitor" GTK is written in C making it very portable and easy to produce language bindings for (for Ruby, Python, Bash etc.). So it is possible to write a complete GTK GUI app in Bash script, but so far that has not been done for Qt.
<pre  style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">$ sudo apt-get build-dep qtbase5-dev
 
$ sudo apt-get install libbz2-dev libxslt-dev libxml2-dev shared-mime-info oxygen-icon-theme libgif-dev libvlc-dev libvlccore-dev doxygen gperf bzr libxapian-dev fontforge libgcrypt20-dev libattr1-dev network-manager-dev libgtk-3-dev xsltproc xserver-xorg-dev xserver-xorg-input-synaptics-dev libpwquality-dev modemmanager-dev libxcb-keysyms1-dev libepoxy-dev libpolkit-agent-1-dev libnm-util-dev libnm-glib-dev libegl-mesa-dev libxcb-xkb-dev libqt5x11extras5-dev libwww-perl libxml-parser-perl libjson-perl libboost1.55-dev libgstreamer-plugins-base1.0-dev libgstreamer1.0-dev libarchive-dev liblmdb-dev
 
</pre>
 
  
*'''openSUSE:''' All the necessary dependencies:
+
== Safety Precautions ==
<pre  style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">$ sudo zypper si -d libqt5-qtbase
+
Configuring your build environment is the single most important step in building KDE software. Luckily, KDE Frameworks development libraries are packaged by most major distributions. In general, building and installing user space programs such as Calligra can be done safely without altering any system files. Whenever possible, it is recommended that you build KDE using your normal user account. Unless you are interested in changing the behavior of your system, you should build with a normal account. Even if you are a a KWin or Plasma developer wishing to test a full Plasma session with compositing effects, there are ways to construct the desired testing bed entirely within your normal user account, e.g. running Plasma through a nested X server using xypher.
$ sudo zypper in libbz2-devel libxslt-devel libxml2-devel shared-mime-info oxygen-icon-theme giflib-devel vlc-devel doxygen gstreamer-0_10-devel gstreamer-0_10-plugins-base-devel docbook-xml-slides docbook-xsl-stylesheets xcb-util-keysyms-devel perl-JSON boost-devel libxcb-devel libXrender-devel xcb-util-wm-devel xcb-util-devel xcb-util-image-devel gettext-tools libepoxy-devel
 
$ sudo zypper in gtk3-devel # for kde-gtk-config
 
$ sudo zypper in grantlee5 # for kdevplatform
 
$ sudo zypper in libkdcraw-devel liblcms2-devel # for gwenview
 
</pre>
 
Optional for kdeplasma-addons: libibus >=1.4.2 (see http://software.opensuse.org/package/libibus-1_0-5)
 
*'''Fedora:''' All the dependencies used for building frameworks can be installed by running:
 
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">
 
$ sudo yum-builddep qt phonon-backend-vlc phonon-backend-gstreamer
 
$ sudo yum install gcc-c++ ruby doxygen git bzr flex bison gperf socat boost-devel bzip2-devel libxslt-devel libxml2-devel shared-mime-info oxygen-icon-theme giflib-devel xcb-util-keysyms-devel perl-JSON perl-Pod-Usage "*xcb*-devel" perl-XML-Parser NetworkManager-glib-devel xapian-core-devel libxkbcommon-devel libxkbcommon-x11-devel systemd-devel libwayland-cursor-devel libwayland-server-devel libepoxy-devel gtk3-devel sane-backends-devel libattr-devel libcanberra-devel libusb-devel libxkbfile-devel fontforge-devel libical-devel gpgme-devel cyrus-sasl-devel openldap-devel libpwquality-devel polkit-devel lmdb-devel
 
</pre>
 
*'''Arch Linux:''' All the dependencies used for building frameworks can be installed by running:
 
<pre  style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">
 
$ sudo pacman -Sy --needed phonon-qt5 qt5-webkit qt5-script qt5-svg qt5-tools qt5-x11extras enchant jasper openexr libutempter docbook-xsl shared-mime-info giflib libxss upower udisks2 bzr git doxygen perl-json perl-libwww perl-xml-parser
 
</pre>
 
$ <your_AUR_helper> kf5-akonadi-git
 
  
=== Qt 5 ===
+
However, to permanently alter your Plasma desktop environment through new System Configuration Modules and the like, you will often need to install shared libraries and other files in system folders. In these cases, bad installation can render your system unstable or your desktop environment unusable.  '''Always take caution before executing any commands as root!'''  A <code>sudo make install</code> '''can not always be undone by''' a simple <code>sudo make uninstall</code>  . Technologies like containerization may help solve these problems in the future, but current distribution systems have no way to monitor the alterations you make to system shared libraries as the system administrator. Another option is to use snapshots of a BTRfs formatted system harddisk and use snapper-GUI to roll back in case of an error. Always keep records of what you are doing and make sure you know how to access the install logs to give yourself a better chance of reverting files by hand if necessary. And of course, please keep high quality, frequent backups of your data.
Qt 5 (http://qt.io/) is the base of KDE software. Choose one of the following sections to get your Qt setup. If you build Qt with the intention to actually develop Qt patches then you should go for a full debug build. If you merely need Qt to develop KDE applications then you should go for the release with debug symbol version.
 
  
{{Note|<b>ArchLinux users</b>: qtwebkit and qtwebengine use Python to generate some files, but they use Python 2.x syntax. So you have to make ''python'' pointing to ''/usr/bin/python2'', to do that see the [https://wiki.archlinux.org/index.php/Python#Python_2 Arch Wiki].}}
+
== Configuration scripts  ==
 +
A set of configuration scripts and bash commands are provided as a recommended configuration when building KDE software manually.  If you use these as provided then your build will be a lot easier and it will be easier for you to find support online. The one disadvantage to these scripts is that they hide important details from you which you may want to learn about. However the scripted and by-hand methods are completely interchangeable so once you are comfortable building KDE using the scripts you can learn more by doing everything yourself.
  
==== Qt5 full debug build ====
+
If you want to do the work by hand you can follow the [[/Details|detailed instructions]] else continue here on.
* PRO: full control and debugging capabilities
 
* CON: takes long to compile on the first time, might be an additional source of errors for beginners
 
  
To build all of qt5 execute:
+
== Install required devel packages ==
<syntaxhighlight lang="bash">
 
git clone git://code.qt.io/qt/qt5.git --branch 5.4
 
cd qt5
 
./init-repository
 
./configure -prefix $PWD/qtbase -opensource -confirm-license -nomake tests -nomake examples \
 
  -dbus -no-separate-debug-info -xcb -system-xcb -qpa xcb -no-gtkstyle -developer-build
 
make
 
</syntaxhighlight>
 
  
To update qt5 later:
+
This section provides information about '''required''' and '''optional''' software packages needed to build the KDE applications.
<syntaxhighlight lang="bash">
 
git pull
 
git submodule sync
 
git submodule update --recursive
 
</syntaxhighlight>
 
 
 
If you saw changes (i.e. qt5.git got updated since last time),
 
<syntaxhighlight lang="bash">
 
./configure [...same as above...]
 
make
 
echo $?    # you should make extra sure that 'make' didn't abort with an error, especially when using -j
 
</syntaxhighlight>
 
  
Experimental and not officially supported: if you don't have enough time and disk space for all of qt5, you could restrict yourself to separate checkouts of qtbase.git, qtsvg.git, qtx11extras.git, qtscript.git and qttools.git, this is enough to build frameworks/* (but not enough for plasma-framework).
+
[https://www.qt.io/ Qt5] is the base of KDE software. Your distro provides suitable devel packages containing prominently the Qt C++ header files below /usr/include/****'''.h''' . Optionally, you can [[/OwnQt5| build your own Qt5]].
  
==== Qt5 release with debug symbols build ====
+
Follow this page to [[/Install the dependencies|install the required dependencies]].
* PRO: This build is the most ideal build when developing applications and tuning performance. It has the speed of a release build but with debug symbols which give you more information in for example kcachegrind with data collected through valgrind.
 
* CON: The Qt libraries will be quite a lot bigger due to the debug symbols.
 
  
To build all of qt5 execute:
+
== Git remote prefix ==
<syntaxhighlight lang="bash">
+
See [[Get Involved/development#Configure Git]]
git clone git://code.qt.io/qt/qt5.git --branch 5.4
 
cd qt5
 
./init-repository
 
./configure -prefix $PWD/qtbase -opensource -confirm-license -nomake tests -nomake examples -dbus \
 
  -no-separate-debug-info -xcb -system-xcb -qpa xcb -no-gtkstyle -release -force-debug-info -reduce-relocations \
 
  -optimized-qmake
 
make
 
</syntaxhighlight>
 
  
==== Use packages from your distribution ====
+
== kdesrc-build ==
* PRO: faster to get started, one source of errors less
+
See [[Get Involved/development#Set up kdesrc-build]]
* CON: usually doesn't have debug symbols. Great for developing applications and measuring performance. Not so great for tuning performance (you'd need debug symbols for that).
 
  
Note that the Qt version currently must be '''>= 5.4'''
+
= Testing =
 +
== Running unit tests ==
 +
Unit tests are ran from the build dir of each framework; you should first <code>cd</code> into it.
  
1) openSUSE:
+
You need a separate DBus session because the dbus server needs to have the right value of XDG_DATA_DIRS, in order to find $KF5/share/dbus-1/services for starting services (e.g. kded5).
* 13.2: add the repository http://download.opensuse.org/repositories/KDE:/Qt54/openSUSE_13.2/
 
* install packages:
 
<pre  style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">
 
$ sudo zypper install libqt5-qttools libgypsy0 libqt5-creator libqt5-linguist libqt5-qtbase-common-devel libqt5-qtbase-debugsource libqt5-qtbase-devel libqt5-qtbase-doc libqt5-qtbase-examples libqt5-qtdeclarative-debugsource libqt5-qtdeclarative-devel libqt5-qtdeclarative-examples libqt5-qtdeclarative-tools libqt5-qtdoc libqt5-qtgraphicaleffects libqt5-qtimageformats libqt5-qtimageformats-debugsource libqt5-qtimageformats-devel libqt5-qtmultimedia-devel libqt5-qtmultimedia-examples libqt5-qtquick1-devel libqt5-qtquickcontrols libqt5-qtscript-devel libqt5-qtscript-examples libqt5-qtsvg-devel libqt5-qttools-debugsource libqt5-qttools-devel libqt5-qtx11extras-devel libqt5-qtxmlpatterns-devel libqt5-qtxmlpatterns-examples libQt5CLucene5 libQt5Concurrent-devel libQt5Concurrent5 libQt5Core-devel libQt5Core5 libQt5DBus-devel libQt5DBus5 libQt5Declarative5 libQt5Designer5 libQt5DesignerComponents5 libQt5Gui-devel libQt5Gui5 libQt5Help5 libQt5Multimedia5 libQt5Network-devel libQt5Network5 libQt5OpenGL-devel libQt5OpenGL5 libQt5Positioning5 libQt5PrintSupport-devel libQt5PrintSupport5 libQt5Script5 libQt5Sensors5 libQt5Sql-devel libQt5Sql5 libQt5Sql5-mysql libQt5Sql5-postgresql libQt5Sql5-sqlite libQt5Sql5-unixODBC libQt5Svg5 libQt5Test-devel libQt5Test5 libQt5WebKit5 libQt5WebKitWidgets5 libQt5Widgets-devel libQt5Widgets5 libQt5X11Extras5 libQt5Xml-devel libQt5Xml5 libQt5XmlPatterns5 libQtQuick5 libQt5WebKitWidgets-devel libqt5-qtbase-private-headers-devel
 
</pre>
 
(these might be too much packages but with those the KF5 build worked)
 
  
2) Debian
+
<syntaxhighlight lang="bash">
* For now, Qt >= 5.4 can only be found in experimental repository. If it's not already the case, add it to your sources list and update : 
+
$ eval `dbus-launch`
<pre  style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">
+
$ kdeinit5
$ echo 'deb http://ftp.debian.org/debian experimental main' >> /etc/apt/sources.list
+
$ make test
$ sudo apt-get update
+
</syntaxhighlight>
  
$ sudo apt-get install -t experimental qtbase5-dev qtbase5-private-dev libqt5x11extras5-dev qtscript5-dev qttools5-dev libqt5svg5-dev libqt5xmlpatterns5-dev qttools5-dev-tools qtdeclarative5-dev
+
'''Note:''' Regular apps will start kdeinit5 automatically. The reason it has to be started by hand when running unit tests is some strange interaction with ctest.
</pre>
 
  
3) Other distributions: yet to be documented.
+
'''Warning:''' never start a KDE 4 application in this separate DBus session. It would conflict with your running Plasma 4 desktop.
  
=== Alternative: compile KF5 into Docker ===
+
'''Note:''' <tt>KDE_FULL_SESSION=true</tt> is needed to make sure that the correct QPA will be loaded.
You can use Docker to keep your main system clean and avoid to install a lot of packages.
 
  
Follow the instructions given at the follow repository: https://github.com/Mathux/docker-kdesrc-build
+
Many of the tests require an X server, and will pop up windows briefly. An easy way to allow these tests to run without interfering with your normal X session is to do
  
Hints for openSUSE to get started:
+
<syntaxhighlight lang="bash">
 
+
  $ xvfb-run -s '-screen 0 1024x768x24' make test
1) '''install'''
 
sudo zypper install docker
 
 
 
2) If the error message
 
<pre  style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">
 
FATA[0000] Post http:///var/run/docker.sock/v1.16/images/create?fromImage=busybox%3Alatest: dial unix /var/run/docker.sock: no such file or directory
 
</pre>
 
appears whenever trying to execute any docker command then you have to start:
 
  sudo systemctl '''start docker'''
 
 
 
3) Add your user to the '''docker group'''
 
 
 
4) Proceed as described in the github project.
 
 
 
5) Beware of '''low disk space''' on your root partition (see http://blog.eye48.com/post/98551740424/when-docker-io-eats-up-your-disc-space)
 
 
 
= Build KDE Frameworks and its dependencies =
 
{{Note|For instructions on building and running Plasma 5, see [[Plasma/Building]].}}
 
== Git remote prefix ==
 
Let's setup a "kde:" prefix for git commands. Add the following text to your ~/.gitconfig:
 
<syntaxhighlight lang="ini">
 
[url "git://anongit.kde.org/"]
 
  insteadOf = kde:
 
[url "ssh://git@git.kde.org/"]
 
  pushInsteadOf = kde:
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== Clone kdesrc-build ==
+
The -s argument tells Xvfb to set the first screen to be 1024x768 pixels, with a depth of 24; at least one test requires a depth greater than 8. In this case, if you also ensure <tt>DBUS_SESSION_BUS_ADDRESS</tt> is not set, the tests should not find your existing DBus session, and instead launch a new DBus instance.
First you need kdesrc-build, it can be done with the following commands:
 
<pre>
 
mkdir -p extragear/utils
 
git clone kde:kdesrc-build extragear/utils/kdesrc-build
 
ln -s extragear/utils/kdesrc-build/kdesrc-build .
 
</pre>
 
 
 
== Download the configuration file ==
 
At this point,
 
# download http://www.davidfaure.fr/kde/kf5-qt5-kdesrc-buildrc into your source dir
 
# rename it to '''kdesrc-buildrc'''
 
You can use this command:
 
<pre>
 
wget "http://www.davidfaure.fr/kde/kf5-qt5-kdesrc-buildrc" -O "kdesrc-buildrc"
 
</pre>
 
== Adjust the paths ==
 
Take a look at those lines in the configuration file you've downloaded:
 
<pre>
 
  # note that the qtdir line is not needed and can be commented out
 
  #  when using distro installed Qt 5 packages
 
  qtdir /d/qt/5/kde/qtbase
 
  source-dir /d/kde/src/5
 
  build-dir /d/kde/build/5
 
  kdedir /d/kde/inst/kde_frameworks
 
</pre>
 
and adjust the paths the way you want.
 
* qtdir = Where Qt 5 is installed, or qtbase build dir if using uninstalled
 
* source-dir = where KDE Frameworks 5 sources should be downloaded
 
* build-dir = where KDE Frameworks 5 should be built
 
* kdedir = your KDE Frameworks 5 installation directory
 
 
 
Note: Append '''-std=c++11''' to the '''cxxflags''' in the '''kdesrc-buildrc'''. Otherwise, you'll be no able to build libdbusmenu-qt.
 
{{Note|The value of <tt>'''''kde-dir'''''/share</tt> must be included in the environment variable <tt>'''XDG_DATA_DIRS'''</tt> or otherwise the build will fail. kdesrc-build should handle this for you.}}
 
{{Note|The Qt dir must be included in the environment variable <tt>'''CMAKE_PREFIX_PATH'''</tt> otherwise kdesrc-build will fail to configure most modules.}}
 
 
 
== Run kdesrc-build ==
 
{{Note|Note that this script uses GIT and Bazaar to download the sources, so ensure you have both installed. }}
 
{{Note|Ensure that C++ compiler is g++. Building KDE with clang has linking errors.}}
 
You just have to run <code>./kdesrc-build</code> to build the KDE Frameworks.
 
It is the preferred way of building KDE Frameworks.
 
 
 
{{Note|kdesrc-build will only pick up the kdesrc-buildrc file you downloaded and edited above if it is in the same directory you run kdesrc-build from.  If you save it to ~/.kdesrc-buildrc, however, it will be used no matter where you run kdesrc-build from. }}
 
 
 
If you want you can also do the work by hand following the detailed instructions: [[Frameworks/Building/Details]].
 
 
 
Example for openSUSE 13.1 with pre-built Qt 5 packages installed via zypper:
 
# directory structure looks like this now:
 
# src/
 
#  extragear/
 
#    utils/
 
#      kde-srcbuild/
 
#  kdesrc-build [symlink to extragear/utils/kde-srcbuild/kdesrc-build]
 
#
 
$ cd <your kf5 src dir where kdesrc-build symlink is located>
 
$ export CMAKE_PREFIX_PATH=/usr/lib64/cmake/Qt5
 
$ ./kdesrc-build
 
 
 
=== Analyse and fix build errors ===
 
 
 
If kdesrc-build shows you red module names with messages like "Unable to configure plasma-mediacenter with CMake!" or "Unable to build kdepim!", you have to start troubleshooting:
 
* The latest build log is written to <pre>src/log/latest/<module-name>/</pre>
 
* In case of error there will be an '''error.log''' file with useful information. You will often see that there is only a build dependency missing.
 
  
== Use Kubuntu CI ==
+
Note that the KWindowSystem tests require a NETWM-compatible window manager to be running.  One way to do this is to create a script to run such a window manager, followed by whatever is passed to it.  For example, if you have the window manager [http://awesome.naquadah.org/ awesome] installed, you could create a script called <tt>awesome-run</tt> as follows:
[https://community.kde.org/Kubuntu/PPAs#Kubuntu_Continuous_Integration_.28CI.29 Kubuntu CI] (replaces Project Neon 5) provides packages of KDE Git master for KDE Frameworks and Plasma 5.  Install them on your Kubuntu system to work with KDE Git.
 
  
= Runtime setup =
 
To use your new KF5 install prefix (let's call it $KF5) :
 
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
export KF5=<path to your intended frameworks install directory>
+
#!/bin/sh
export QTDIR=<path to your qt5 install dir, or qtbase build dir if using uninstalled>
+
awesome &
export XDG_DATA_DIRS=$KF5/share:$XDG_DATA_DIRS:/usr/share
+
exec "$@"
export XDG_CONFIG_DIRS=$KF5/etc/xdg:$XDG_CONFIG_DIRS:/etc/xdg
 
export PATH=$KF5/bin:$QTDIR/bin:$PATH
 
export QT_PLUGIN_PATH=$KF5/lib/plugins:$KF5/lib64/plugins:$KF5/lib/x86_64-linux-gnu/plugins\
 
:$QTDIR/plugins:$QT_PLUGIN_PATH
 
#  (lib64 instead of lib, on OpenSUSE and similar)
 
export QML2_IMPORT_PATH=$KF5/lib/qml:$KF5/lib64/qml:$KF5/lib/x86_64-linux-gnu/qml:$QTDIR/qml
 
export QML_IMPORT_PATH=$QML2_IMPORT_PATH
 
export KDE_SESSION_VERSION=5
 
export KDE_FULL_SESSION=true
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Note that LD_LIBRARY_PATH isn't set. You shouldn't set it, the builtin rpath works magic instead, and if you set it you'll have issues when running tools that use uninstalled libs while building frameworks (e.g. meinproc, kconfig_compiler...)
+
and then run the tests as
  
To use separate user settings for KF5:
 
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
export XDG_DATA_HOME=$HOME/.local5/share
+
$ xvfb-run -s '-screen 0 1024x768x24' /path/to/awesome-run make test
export XDG_CONFIG_HOME=$HOME/.config5
 
export XDG_CACHE_HOME=$HOME/.cache5
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
To be able to compile other stuff on top of KF5:
+
If you want to publish your test results, instead of "make test" run
<syntaxhighlight lang="bash">
 
export CMAKE_PREFIX_PATH=$KF5:$CMAKE_PREFIX_PATH
 
</syntaxhighlight>
 
  
To get more information out of qDebug statements (i.e. make it more like kDebug) :
 
<syntaxhighlight lang="bash">
 
export QT_MESSAGE_PATTERN='%{appname}(%{pid})/%{category} %{function}: %{message}'
 
</syntaxhighlight>
 
or even better, to get colors:
 
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
c=`echo -e "\033"`
+
$ make Experimental
export QT_MESSAGE_PATTERN="%{appname}(%{pid})/(%{category}) ${c}[31m%{if-debug}${c}[34m%{endif}\
 
%{function}${c}[0m: %{message}"
 
unset c
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
To set a KDE5 default editor (for git and svn)
+
The test results will appear on http://my.cdash.org/index.php?project=&lt;projectname&gt;
<syntaxhighlight lang="bash">
 
export EDITOR="kwrapper5 kwrite"
 
</syntaxhighlight>
 
  
Don't bother with KDEDIR and KDEHOME etc.  this stuff isn't used anymore.
+
== Testing Plasma ==
  
$ which ksnapshot
+
See [[Get Involved/development#Plasma]]
 
 
should show you now the location of the built version, ''not'' the one in the system path /usr/bin/ if you setup the paths correctly.
 
 
 
To '''run an application''', e.g. ksnapshot, you need a separate DBus session because the dbus server needs to have the right value of XDG_DATA_DIRS, in order to find $KF5/share/dbus-1/services for starting services (e.g. kded5). (Only needed when working under KDE4?). Kded5 is not needed for every feature but everytime when kioexec (which is used by KRun) is involved.
 
 
 
$ eval `dbus-launch` # no console output expected, (kdeinit5 is started automatically when needed)
 
$ ksnapshot
 
 
 
= Running unit tests =
 
Unit tests are ran from the build dir of each framework, you should first cd into it.
 
 
 
You need a separate DBus session because the dbus server needs to have the right value of XDG_DATA_DIRS, in order to find $KF5/share/dbus-1/services for starting services (e.g. kded5).
 
 
 
<pre>
 
eval `dbus-launch`
 
kdeinit5
 
make test
 
</pre>
 
 
 
Note: Regular apps will start kdeinit5 automatically. The reason it has to be started by hand when running unittests is some strange interaction with ctest.
 
 
 
Warning: never start a KDE 4 application in this separate DBus session, it would conflict with your running Plasma 4 desktop.
 
Note: KDE_FULL_SESSION=true is needed to make sure that the correct QPA will be loaded.
 
 
 
Many of the tests require an X server, and will pop up windows briefly.  An easy way to allow these tests to run without interfering with your normal X session is to do <pre>
 
xvfb-run -s '-screen 0 1024x768x24' make test
 
</pre>
 
(the -s argument tells Xvfb to set the first screen to be 1024x768 pixels, with a depth of 24; at least one test requires a depth greater than 8).  In this case, if you also ensure <tt>DBUS_SESSION_BUS_ADDRESS</tt> is not set, the tests should not find your existing D-Bus session, and instead launch a new D-Bus instance.
 
 
 
Note that the KWindowSystem tests require a NETWM-compatible window manager to be running.  One way to do this is to create a script to run such a window manager, followed by whatever is passed to it.  For example, if you have the window manager [http://awesome.naquadah.org/ awesome] installed, you could create a script called <tt>awesome-run</tt> as follows: <syntaxhighlight lang="bash">
 
#!/bin/sh
 
awesome &
 
exec "$@"
 
</syntaxhighlight>
 
and then run the tests as <pre>
 
xvfb-run -s '-screen 0 1024x768x24' /path/to/awesome-run make test
 
</pre>
 
 
 
If you want to publish your test results, instead of "make test" run <pre>
 
make Experimental
 
</pre>
 
The test results will appear on http://my.cdash.org/index.php?project=&lt;projectname&gt;
 
  
 
= Troubleshooting =
 
= Troubleshooting =
  
 
== Compilation: how to quickly solve build problems ==
 
== Compilation: how to quickly solve build problems ==
 
+
See [[Get Involved/development#How to solve build problems]]
Situation:
 
 
 
One or more modules fail to build via kdesrcbuild (displayed in red font).
 
 
 
'''Steps to solve''' (in the given order):
 
 
 
1) Check KDE build server if the module is maybe currently broken: http://build.kde.org/view/FAILED/
 
 
 
For the next two steps we assume your kf5 development directory structure looks like this:
 
kf5
 
  `- build
 
  `- src
 
  `- usr
 
 
 
2) Delete '''usr''' and run kdesrcbuild again.
 
 
 
3) see [https://community.kde.org/Frameworks/Building#Analyse_and_fix_build_errors Analyse and fix build errors]
 
 
 
4) Delete '''build''' and '''usr'''. Run kdesrcbuild again.
 
 
 
5a) Ask on IRC or mailing list (see [https://community.kde.org/Getinvolved/development#Communicating_with_the_team Communicating with the team])
 
 
 
5b) Check if there are changes in the build instructions: see History of this wiki page.
 
 
 
6) Start over from scratch.
 
 
 
== Runtime: generic runtime problem ==
 
 
 
Try to delete ~/.cache5, ~/.config5, ~/.local5
 
 
 
(WARN: make sure not accidently delete your own config, the directories without the 5)
 
  
 
== Runtime: Segfault when a sound is about to play (e.g. for a message box) ==
 
== Runtime: Segfault when a sound is about to play (e.g. for a message box) ==
Line 338: Line 90:
 
Example of the problem: open kate, edit some file without saving, Ctrl+W to close, a message box is about to appear and the then segfault:
 
Example of the problem: open kate, edit some file without saving, Ctrl+W to close, a message box is about to appear and the then segfault:
  
 +
<pre>
 
  kate(9037)/default KNotificationManager::notify: Calling notify on "Sound"
 
  kate(9037)/default KNotificationManager::notify: Calling notify on "Sound"
 
  Segmentation fault
 
  Segmentation fault
 +
</pre>
  
 
This command can solve the problem:
 
This command can solve the problem:
  
  sudo /usr/lib64/vlc/vlc-cache-gen -f /usr/lib64/vlc/plugins
+
<syntaxhighlight lang="bash">
 +
  $ sudo /usr/lib64/vlc/vlc-cache-gen -f /usr/lib64/vlc/plugins
 +
</syntaxhighlight>
  
 
See also:
 
See also:
* https://community.kde.org/Plasma/5.1_Errata
+
* [[Plasma/5.1_Errata]]
 
* https://forum.kde.org/viewtopic.php?f=289&t=122996
 
* https://forum.kde.org/viewtopic.php?f=289&t=122996
  
Line 354: Line 110:
 
(added: 2015-Jan)
 
(added: 2015-Jan)
  
Situation:
+
'''Situation:'''
 
kded5 is started but crashes because of some dependency. Stacktraces show for example `bluedevil` as possible cause.
 
kded5 is started but crashes because of some dependency. Stacktraces show for example `bluedevil` as possible cause.
  
Goal 1: disable the component to verify it as crash cause.
+
'''Goal 1: Disable the component to verify it as crash cause.'''
  
 
Steps:
 
Steps:
  
1) locate bluedevil files using `locate bluedevil`, for example.  
+
# Locate bluedevil files using <code>locate bluedevil</code>, for example.  
 +
# Among the files there is <tt>kde/usr/share/kservices5/kded/bluedevil.desktop</code>. Remove it. If it was the cause, kded should stop crashing
  
2) Among the files there is `dev/kf5/usr/share/kservices5/kded/bluedevil.desktop`. Remove it.
+
'''Goal 2: Remove bluedevil from kdesrcbuild until it gets fixed.'''
If it was the cause, kded should stop crashing
 
 
 
Goal 2: Remove bluedevil from kdesrcbuild until it gets fixed.
 
  
 
Steps:
 
Steps:
  
1) Search through the dev/kf5/src/extragear/utils/kdesrc-build/*-build-include files to find the component. In this case, it was found in kf5-workspace-build-include.
+
# Search through the <code>dev/kf5/src/extragear/utils/kdesrc-build/*-build-include</code> files to find the component. In this case, it was found in kf5-workspace-build-include.
 
+
# Comment it out:
2) Comment it out:
+
<pre>
 
  # module-set kf5-bluetooth-management
 
  # module-set kf5-bluetooth-management
 
  #    repository kde-projects
 
  #    repository kde-projects
 
  #    use-modules libbluedevil bluedevil
 
  #    use-modules libbluedevil bluedevil
 
  # end module-set
 
  # end module-set
 
Further calls of `kdesrcbild` will not include the component.
 
 
== Runtime: Couldn't start kded5 (KDE4) ==
 
(added: 2014-Dec)
 
 
Situation: developing and executing KF5 apps under KDE 4.
 
 
Problem by example: error message on console when starting ksnapshot in KF5 environment
 
 
<pre  style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">
 
ksnapshot(26577)/default KSycocaPrivate::checkDatabase: Couldn't start kded5 from org.kde.kded5.service: QDBusError("org.freedesktop.DBus.Error.ServiceUnknown", "The name org.kde.kded5 was not provided by any .service files") , falling back to running kbuildsycoca5
 
 
</pre>
 
</pre>
  
Solution (not verified yet): as said in the article, run this command before starting the app itself:
+
Further calls of <code>kdesrc-build</code> will not include the component.
 
. setup-kf5-env      # (or as your script is called)
 
eval `dbus-launch`    # no output expected
 
ksnapshot            # no kded5 error message expected
 
  
== Runtime: Icon theme was changed (KDE4) ==
+
== Get more help ==
(added: 2014-Oct, verified: 2015-Feb)
 
  
Situation: developing and executing KF5 apps under KDE 4.
+
If you still have trouble with the building process or runtime setup, you can contact people as described in [[Get_Involved/development#Communicating_with_the_team|Communicating with the team]].
  
Problem: After working a bit with KF5 applications your regular KDE icon theme might be changed from oxygen to breeze.
+
Feel free to join us by visiting [irc://irc.freenode.net/#kde-devel #kde-devel on Freenode]. A web-based client can be found at https://kiwiirc.com/client/irc.freenode.org/kde-devel
  
Solution: see https://forum.kde.org/viewtopic.php?f=67&t=25032: Open "Icons - KDE Control Module" and change the theme back to Oxygen.
+
= Alternative building methods =
 
 
== Get more help ==
 
  
If you still have trouble with the building process or runtime setup you can contact people as described in [https://community.kde.org/Getinvolved/development#Communicating_with_the_team Communicating with the team].  
+
== Kubuntu CI ==
 +
[[Kubuntu/PPAs#Kubuntu_Continuous_Integration_.28CI.29|Kubuntu CI]] (replaces Project Neon 5) provides packages of KDE Git master for KDE Frameworks and Plasma 5.  Install them on your Kubuntu system to work with KDE Git.
  
More specifically, here is a list of beginner people who have recently had built the project and would like to specifically help with build problems. Feel free to add them to the recipient list when writing to the mailing list:
+
== openSUSE Build Service ==
 +
[https://en.opensuse.org/SDB:KDE_repositories#Unstable_Frameworks.2C_Plasma_and_Applications The openSUSE Build Service] provides packages of KDE Git master for KDE Frameworks, Plasma, Applications and Extragear. It offers repositories for Tumbleweed and the latest stable (Leap) release.
  
* Gregor Mi (codestruct at posteo dot org) (build KF5 on openSUSE 13.2 running latest KDE 4)
+
== Docker ==
 +
The docker container keeps the target KDE separate from the working installation, so no "contamination" with unstable code can occur.
 +
* [[/Alternatives | Build with docker]]

Latest revision as of 15:38, 22 June 2019

Build KDE Frameworks and Applications

Design features

Qt and most KDE software are written in C++ whereas its "competitor" GTK is written in C making it very portable and easy to produce language bindings for (for Ruby, Python, Bash etc.). So it is possible to write a complete GTK GUI app in Bash script, but so far that has not been done for Qt.

Safety Precautions

Configuring your build environment is the single most important step in building KDE software. Luckily, KDE Frameworks development libraries are packaged by most major distributions. In general, building and installing user space programs such as Calligra can be done safely without altering any system files. Whenever possible, it is recommended that you build KDE using your normal user account. Unless you are interested in changing the behavior of your system, you should build with a normal account. Even if you are a a KWin or Plasma developer wishing to test a full Plasma session with compositing effects, there are ways to construct the desired testing bed entirely within your normal user account, e.g. running Plasma through a nested X server using xypher.

However, to permanently alter your Plasma desktop environment through new System Configuration Modules and the like, you will often need to install shared libraries and other files in system folders. In these cases, bad installation can render your system unstable or your desktop environment unusable. Always take caution before executing any commands as root! A sudo make install can not always be undone by a simple sudo make uninstall . Technologies like containerization may help solve these problems in the future, but current distribution systems have no way to monitor the alterations you make to system shared libraries as the system administrator. Another option is to use snapshots of a BTRfs formatted system harddisk and use snapper-GUI to roll back in case of an error. Always keep records of what you are doing and make sure you know how to access the install logs to give yourself a better chance of reverting files by hand if necessary. And of course, please keep high quality, frequent backups of your data.

Configuration scripts

A set of configuration scripts and bash commands are provided as a recommended configuration when building KDE software manually. If you use these as provided then your build will be a lot easier and it will be easier for you to find support online. The one disadvantage to these scripts is that they hide important details from you which you may want to learn about. However the scripted and by-hand methods are completely interchangeable so once you are comfortable building KDE using the scripts you can learn more by doing everything yourself.

If you want to do the work by hand you can follow the detailed instructions else continue here on.

Install required devel packages

This section provides information about required and optional software packages needed to build the KDE applications.

Qt5 is the base of KDE software. Your distro provides suitable devel packages containing prominently the Qt C++ header files below /usr/include/****.h . Optionally, you can build your own Qt5.

Follow this page to install the required dependencies.

Git remote prefix

See Get Involved/development#Configure Git

kdesrc-build

See Get Involved/development#Set up kdesrc-build

Testing

Running unit tests

Unit tests are ran from the build dir of each framework; you should first cd into it.

You need a separate DBus session because the dbus server needs to have the right value of XDG_DATA_DIRS, in order to find $KF5/share/dbus-1/services for starting services (e.g. kded5).

 $ eval `dbus-launch`
 $ kdeinit5
 $ make test

Note: Regular apps will start kdeinit5 automatically. The reason it has to be started by hand when running unit tests is some strange interaction with ctest.

Warning: never start a KDE 4 application in this separate DBus session. It would conflict with your running Plasma 4 desktop.

Note: KDE_FULL_SESSION=true is needed to make sure that the correct QPA will be loaded.

Many of the tests require an X server, and will pop up windows briefly. An easy way to allow these tests to run without interfering with your normal X session is to do

 $ xvfb-run -s '-screen 0 1024x768x24' make test

The -s argument tells Xvfb to set the first screen to be 1024x768 pixels, with a depth of 24; at least one test requires a depth greater than 8. In this case, if you also ensure DBUS_SESSION_BUS_ADDRESS is not set, the tests should not find your existing DBus session, and instead launch a new DBus instance.

Note that the KWindowSystem tests require a NETWM-compatible window manager to be running. One way to do this is to create a script to run such a window manager, followed by whatever is passed to it. For example, if you have the window manager awesome installed, you could create a script called awesome-run as follows:

#!/bin/sh
awesome &
exec "$@"

and then run the tests as

$ xvfb-run -s '-screen 0 1024x768x24' /path/to/awesome-run make test

If you want to publish your test results, instead of "make test" run

$ make Experimental

The test results will appear on http://my.cdash.org/index.php?project=<projectname>

Testing Plasma

See Get Involved/development#Plasma

Troubleshooting

Compilation: how to quickly solve build problems

See Get Involved/development#How to solve build problems

Runtime: Segfault when a sound is about to play (e.g. for a message box)

(added: 2015-02-27)

Example of the problem: open kate, edit some file without saving, Ctrl+W to close, a message box is about to appear and the then segfault:

 kate(9037)/default KNotificationManager::notify: Calling notify on "Sound"
 Segmentation fault

This command can solve the problem:

 $ sudo /usr/lib64/vlc/vlc-cache-gen -f /usr/lib64/vlc/plugins

See also:

Alternative: go to kf5/build/kdesupport/phonon/phonon-vlc/ and exec `make uninstall`

Runtime: kded5 crashes because of some component

(added: 2015-Jan)

Situation: kded5 is started but crashes because of some dependency. Stacktraces show for example `bluedevil` as possible cause.

Goal 1: Disable the component to verify it as crash cause.

Steps:

  1. Locate bluedevil files using locate bluedevil, for example.
  2. Among the files there is kde/usr/share/kservices5/kded/bluedevil.desktop. Remove it. If it was the cause, kded should stop crashing

Goal 2: Remove bluedevil from kdesrcbuild until it gets fixed.

Steps:

  1. Search through the dev/kf5/src/extragear/utils/kdesrc-build/*-build-include files to find the component. In this case, it was found in kf5-workspace-build-include.
  2. Comment it out:
 # module-set kf5-bluetooth-management
 #     repository kde-projects
 #     use-modules libbluedevil bluedevil
 # end module-set

Further calls of kdesrc-build will not include the component.

Get more help

If you still have trouble with the building process or runtime setup, you can contact people as described in Communicating with the team.

Feel free to join us by visiting #kde-devel on Freenode. A web-based client can be found at https://kiwiirc.com/client/irc.freenode.org/kde-devel

Alternative building methods

Kubuntu CI

Kubuntu CI (replaces Project Neon 5) provides packages of KDE Git master for KDE Frameworks and Plasma 5. Install them on your Kubuntu system to work with KDE Git.

openSUSE Build Service

The openSUSE Build Service provides packages of KDE Git master for KDE Frameworks, Plasma, Applications and Extragear. It offers repositories for Tumbleweed and the latest stable (Leap) release.

Docker

The docker container keeps the target KDE separate from the working installation, so no "contamination" with unstable code can occur.


This page was last edited on 22 June 2019, at 15:38. Content is available under Creative Commons License SA 4.0 unless otherwise noted.