Guidelines and HOWTOs/Build from source: Difference between revisions

From KDE Community Wiki
(Added link to build on Ubuntu 14.04 LTS)
(Unify formatting and update links)
Line 4: Line 4:
Configuring your build environment is the single most important step in building KDE.  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 KDE 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.
Configuring your build environment is the single most important step in building KDE.  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 KDE 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 KDE/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 <tt>sudo make install</tt> can ''not'' always be undone by a simple <tt>sudo make uninstall.</tt> 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. 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.
However, to permanently alter your KDE/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. 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  ==
== Configuration scripts  ==
A set of configuration scripts and bash commands are provided as a recommended configuration when building KDE manually.  If you use these as provided then your KDE 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.
A set of configuration scripts and bash commands are provided as a recommended configuration when building KDE manually.  If you use these as provided then your KDE 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 [[/Details| detailed instructions]].
If you want to do the work by hand you can follow the [[/Details|detailed instructions]].


== Install required devel packages ==
== Install required devel packages ==
Line 15: Line 15:
This section provides information about '''required''' and '''optional''' software packages needed to build the KDE applications.
This section provides information about '''required''' and '''optional''' software packages needed to build the KDE applications.


Qt 5 (http://qt.io/) is the base of KDE software. Your distro provides suitable devel packages. Optionally, you can [[/OwnQt5| build your own Qt5]].
[https://www.qt.io/ Qt5] is the base of KDE software. Your distro provides suitable devel packages. Optionally, you can [[/OwnQt5| build your own Qt5]].


Follow this page to [[/Install the dependencies | install the required dependencies]].
Follow this page to [[/Install the dependencies|install the required dependencies]].


== Git remote prefix ==
== Git remote prefix ==
Line 28: Line 28:
</syntaxhighlight>
</syntaxhighlight>


== Install kdesrc-build ==
== kdesrc-build ==
''kdesrc-build'' isa user-space package manager, it is used to compile KDE-related projects from source and installs them into a designated directory.
''kdesrc-build'' is a user-space package manager. It is used to compile KDE-related projects from source, and to install them into a designated directory.


Follow the given steps to set up kdesrc-build to install KDevelop into our $HOME directory:
This guide assumes that
* you want to install KDevelop inside your home directory,
* you want to put sources, build and log files into separate subdirectories under <tt>~/kde</tt>, as well as install everything to <tt>~/kde/usr</tt>, and
* you use a Linux system and are familiar with bash.
 
Make sure to adapt these steps to your needs.
 
=== Install kdesrc-build ===
 
Start off by installing ''kdesrc-build'' and creating a basic configuration file:
<pre>
<pre>
mkdir ~/kdesrc 
mkdir -p ~/kde/src
cd ~/kdesrc 
cd ~/kde/src
git clone kde:kdesrc-build
git clone kde:kdesrc-build
cd kdesrc-build
cd kdesrc-build
cp kdesrc-buildrc-kf5-sample ~/.kdesrc-buildrc
cp kdesrc-buildrc-kf5-sample ~/.kdesrc-buildrc


# Install a symlink of kdesrc-build to a location in PATH
# Install a symlink of kdesrc-build to a location in PATH
mkdir ~/bin
mkdir ~/bin
ln -s $PWD/kdesrc-build ~/bin
ln -s $PWD/kdesrc-build ~/bin
export PATH=~/bin:$PATH  
export PATH=~/bin:$PATH
</pre>
</pre>


You will need to append the line <pre>export PATH=~/bin:$PATH</pre> to <pre>~/.bashrc</pre> so kdesrc-build is available in PATH whenever you open a terminal.
You will need to append the line <code>export PATH=~/bin:$PATH</code> to your <tt>~/.bashrc</tt> so <code>kdesrc-build</code> is available in PATH whenever you open a terminal.
 


=== Configure kdesrc-build ===


'''Configure kdesrc-build
Edit <tt>~/.kdesrc-buildrc</tt> and replace <tt>/path/to/kdesrc-build/kf5-qt5-build-include</tt> with <tt>~/kdesrc/kdesrc-build/kf5-qt5-build-include</tt>. Add <tt>ignore-kde-structure true</tt> and <tt>make-options -jN</tt> to the global section. Finally, point ''kdesrc-build'' to the correct source, build, log, and install directories.
'''
edit<pre>~/.kdesrc-buildrc</pre>
Replace <pre>/path/to/kdesrc-build/kf5-qt5-build-include</pre> with <pre>~/kdesrc/kdesrc-build/kf5-qt5-build-include</pre> in ~/.kdesrc-buildrc file


Add <pre>ignore-kde-structure true</pre> and <pre>make-options -jN</pre> to the global section in ~/.kdesrc-buildrc
<syntaxhighlight lang="ini">
<pre>
global
global
   ...
   ...
  # Do not introduce an extra directory hierarchy
   ignore-kde-structure true
   ignore-kde-structure true
   make-options -j5 # NOTE: 5 is the number of jobs, this should usually be (number-of-cpu-cores + 1)
 
   #stop-on-failure       true       # Stop kdesrc-build  
   # set the number of jobs to 5; this should usually
  # be (number-of-cpu-cores + 1)
  make-options      -j5
 
  # Stop kdesrc-build
   #stop-on-failure true
 
  # Directory structure
  src-dir          ~/kde/src
  build-dir        ~/kde/src
  log-dir          ~/kde/log
  kdedir            ~/kde/usr
   ...
   ...
end global
end global
</pre>
</syntaxhighlight>


== Run kdesrc-build ==
=== Run kdesrc-build ===
Installing KDevelop and dependencies


Let kdesrc-build handle the compilation + installation of KDevelop and its (direct) dependencies
To let <code>kdesrc-build</code> handle the compilation and installation of KDevelop and its (direct) dependencies, type


<syntaxhighlight lang="bash">
$ kdesrc-build --debug libkomparediff2 grantlee kdevplatform kdevelop-pg-qt kdevelop
$ kdesrc-build --debug libkomparediff2 grantlee kdevplatform kdevelop-pg-qt kdevelop
</syntaxhighlight>


The <tt>--debug</tt> parameter will give you the verbose output, all command invocations and compiler output. Helpful for trouble-shooting. If you want to compile and install indirect dependencies as well, make sure to add the <tt>--include-dependencies</tt> parameter as well.


The --debug parameter will give you the verbose output, all command invocations and compiler output. Helpful for trouble-shooting.
=== Set up a script for preparing the environment ===


 
Copy and use these commands to a new file called ~/kde/.setup/env:
#Set up a script for preparing the environment
 
Copy and use these commands to a new file called ~/.env-kf5:
<syntaxhighlight lang="ini">
<syntaxhighlight lang="ini">
export KF5=~/kde-5 
export KF5=~/kde/usr
export QTDIR=/usr   
export QTDIR=/usr   
export CMAKE_PREFIX_PATH=$KF5:$CMAKE_PREFIX_PATH   
export CMAKE_PREFIX_PATH=$KF5:$CMAKE_PREFIX_PATH   
Line 86: Line 104:
export PATH=$KF5/bin:$QTDIR/bin:$PATH   
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   
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)
# (lib64 instead of lib on some systems, like OpenSUSE)
export QML2_IMPORT_PATH=$KF5/lib/qml:$KF5/lib64/qml:$KF5/lib/x86_64-linux-gnu/qml:$QTDIR/qml   
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 QML_IMPORT_PATH=$QML2_IMPORT_PATH   
export KDE_SESSION_VERSION=5   
export KDE_SESSION_VERSION=5   
export KDE_FULL_SESSION=true
export KDE_FULL_SESSION=true
PS1="(kdesrc) $PS1"
</syntaxhighlight>
</syntaxhighlight>


A guide for building Plasma 5 specifically on Ubuntu 14.04 LTS can be found [[/Plasma_5_on_Ubuntu_14.04_LTS|here]].
A guide for building Plasma 5 specifically on Ubuntu 14.04 LTS can be found [[/Plasma_5_on_Ubuntu_14.04_LTS|here]].


== Run Kdevelop ==
=== Run Kdevelop ===
Whenever you feel to run a self-compiled KDevelop, you just have to do the following commands in terminal:
 
<syntaxhighlight lang="ini">
Whenever you want to run a self-compiled KDevelop, you just have to do the following commands in terminal:
  $ source ~/.env-kf5
<syntaxhighlight lang="bash">
  $ source ~/kde/.setup/env
  $ kdevelop
  $ kdevelop
</syntaxhighlight>
</syntaxhighlight>


== Analyse and fix build errors ==
=== 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:
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.


* <<<  PACKAGES FAILED TO BUILD  >>>
<pre>
libkomparediff2 - ~/kdesrc/log/<build-date>/libkomparediff2/cmake.log  :-(
<<<  PACKAGES FAILED TO BUILD  >>>
libkomparediff2 - ~/kde/log/<build-date>/libkomparediff2/error.log  :-(
</pre>


Inspect that log to figure out what's going on:
Inspect that log to figure out what's going on:


* $ cat ~/kdesrc/log/<build-date>/libkomparediff2/cmake.log
<syntaxhighlight lang="bash">
CMake Error at CMakeLists.txt:5 (find_package):
$ cat ~/kde/log/<build-date>/libkomparediff2/error.log
</syntaxhighlight>
<pre>
CMake Error at CMakeLists.txt:5 (find_package):
   Could not find a package configuration file provided by "ECM" (requested
   Could not find a package configuration file provided by "ECM" (requested
   version 0.0.9) with any of the following names:
   version 0.0.9) with any of the following names:
Line 120: Line 145:
   to a directory containing one of the above files.  If "ECM" provides a
   to a directory containing one of the above files.  If "ECM" provides a
   separate development package or SDK, be sure it has been installed.
   separate development package or SDK, be sure it has been installed.
</pre>
In this case, the ECM (extra cmake modules) package is missing. Since ECM is a KDE Framework, this error would have been avoided by the <tt>--include-dependencies</tt> parameter mentioned above.


In this case: the ECM (extra cmake modules) package is missing. The way you usually fix these kind of problems is to head over to http://packages.ubuntu.com and search for the distro package providing a particular file (ECMConfig.cmake in this case).
However, this might also happen with dependencies that ''kdesrc-build'' is not able to handle itself. In such cases, you have to install additional packages via your system package manager. Most distribution offer ways to determine which package contains the missing files.


So the package search reveals extra-cmake-modules being a hot candidate; to fix above error we simply install the package and the restart the build:
For Ubuntu, you would head over to http://packages.ubuntu.com and search for the distro package providing a particular file (ECMConfig.cmake in this case). The package search reveals <tt>extra-cmake-modules</tt> being a hot candidate; to fix above error we simply install the package and the restart the build:


* $ apt-get install extra-cmake-modules
<syntaxhighlight lang="bash">
  <restart build>  
$ apt-get install extra-cmake-modules
  $ kdesrc-build ...
  $ kdesrc-build ...
</syntaxhighlight>


The errors should be gone by now.
The error should be gone now.


= Testing =
= Testing =
== Running unit tests ==
== Running unit tests ==
Unit tests are ran from the build dir of each framework, you should first cd into it.
Unit tests are ran from the build dir of each framework; you should first <code>cd</code> 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).
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>
<syntaxhighlight lang="bash">
eval `dbus-launch`
$ eval `dbus-launch`
kdeinit5
$ kdeinit5
make test
$ make test
</pre>
</syntaxhighlight>
 
'''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:''' <tt>KDE_FULL_SESSION=true</tt> is needed to make sure that the correct QPA will be loaded.


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.
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


Warning: never start a KDE 4 application in this separate DBus session, it would conflict with your running Plasma 4 desktop.
<syntaxhighlight lang="bash">
Note: KDE_FULL_SESSION=true is needed to make sure that the correct QPA will be loaded.
$ xvfb-run -s '-screen 0 1024x768x24' make test
</syntaxhighlight>


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>
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.
xvfb-run -s '-screen 0 1024x768x24' make test
 
</pre>
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:
(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">
<syntaxhighlight lang="bash">
#!/bin/sh
#!/bin/sh
awesome &
awesome &
exec "$@"
exec "$@"
</syntaxhighlight>
</syntaxhighlight>
and then run the tests as <pre>
 
and then run the tests as
 
<syntaxhighlight lang="bash">
xvfb-run -s '-screen 0 1024x768x24' /path/to/awesome-run make test
xvfb-run -s '-screen 0 1024x768x24' /path/to/awesome-run make test
</pre>
</syntaxhighlight>
 
If you want to publish your test results, instead of "make test" run


If you want to publish your test results, instead of "make test" run <pre>
<syntaxhighlight lang="bash">
make Experimental
make Experimental
</pre>
</syntaxhighlight>
 
The test results will appear on http://my.cdash.org/index.php?project=&lt;projectname&gt;
The test results will appear on http://my.cdash.org/index.php?project=&lt;projectname&gt;


Line 175: Line 216:
== Compilation: how to quickly solve build problems ==
== Compilation: how to quickly solve build problems ==


Situation:
'''Situation:'''


One or more modules fail to build via kdesrcbuild (displayed in red font).
One or more modules fail to build via <code>kdesrc-build</code> (displayed in red font).


'''Steps to solve''' (in the given order):
'''Steps to solve''' (in the given order):
The following steps assume the directory structure as proposed in the ''kdesrc-build'' guide above.
   
   
1) You may not have all dependencies installed. Read the output to see what missing dependency it is complaining about, search for the corresponding package for your distro, and install it.
# You may not have all dependencies installed. Read the output to see what missing dependency it is complaining about, search for the corresponding package for your distro, and install it.
 
# Check the [https://build.kde.org/view/FAILED/ list of currently broken modules] on the KDE build server.
2) Check KDE build server if the module is maybe currently broken: http://build.kde.org/view/FAILED/
# If you get a build failure, simple fix might be to delete the build folder for that module and try building it again.
 
# See [[#Analyse_and_fix_build_errors | Analyse and fix build errors]].
For the next two steps we assume your kf5 development directory structure looks like this:
# Delete <tt>~/kde/build</tt> and <tt>~/kde/usr</tt>. Run <code>kdesrc-build</code> again.
kf5
# Ask for help on IRC or some mailing list, see [[Getinvolved/development#Communicating_with_the_team| Communicating with the team]].
  `- build
# Check if there are changes in the build instructions: see [https://community.kde.org/index.php?title=Guidelines_and_HOWTOs/Build_from_source&action=history History of this wiki page].
  `- src
# Start over from scratch.
  `- usr
 
3) If you get a build failure, simple fix might be to delete the build folder for that module and try building it again.
 
4) see [[#Analyse_and_fix_build_errors | Analyse and fix build errors]]
 
5) Delete '''build''' and '''usr'''. Run kdesrcbuild again.
 
6a) Ask on IRC or mailing list (see [[Getinvolved/development#Communicating_with_the_team| Communicating with the team]])
 
6b) Check if there are changes in the build instructions: see History of this wiki page.
 
7) 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 214: Line 238:
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 230: Line 258:
(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 <code>locate bluedevil</code>, 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 <code>dev/kf5/usr/share/kservices5/kded/bluedevil.desktop</code>. Remove it.
If it was the cause, kded should stop crashing


'''Goal 2: Remove bluedevil from kdesrcbuild until it gets fixed.'''
'''Goal 2: Remove bluedevil from kdesrcbuild until it gets fixed.'''
Line 246: Line 272:
Steps:
Steps:


1) 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.
# 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>
<pre>
  # module-set kf5-bluetooth-management
  # module-set kf5-bluetooth-management
Line 256: Line 281:
</pre>
</pre>


Further calls of <code>kdesrcbild</code> will not include the component.
Further calls of <code>kdesrc-build</code> will not include the component.


== Runtime: Couldn't start kded5 (KDE4) ==
== Runtime: Couldn't start kded5 (KDE4) ==
(added: 2014-Dec)
(added: 2014-Dec)


Situation: developing and executing KF5 apps under KDE 4.
'''Situation:''' Developing and executing KF5 apps under KDE 4.


Problem by example: error message on console when starting ksnapshot in KF5 environment
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;">
<pre  style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: normal;">
Line 269: Line 294:
</pre>
</pre>


Solution (not verified yet): as said in the article, run this command before starting the app itself:
'''Solution (not verified yet):''' As said in the article, run this command before starting the app itself:
   
   
  . setup-kf5-env      # (or as your script is called)
<syntaxhighlight lang="bash">
  eval `dbus-launch`    # no output expected
  $ . ~/kde/.setup/env      # (or as your script is called)
  ksnapshot            # no kded5 error message expected
  $ eval `dbus-launch`    # no output expected
  $ ksnapshot            # no kded5 error message expected
</syntaxhighlight>


== Runtime: Icon theme was changed (KDE4) ==
== Runtime: Icon theme was changed (KDE4) ==
(added: 2014-Oct, verified: 2015-Feb)
(added: 2014-Oct, verified: 2015-Feb)


Situation: developing and executing KF5 apps under KDE 4.
'''Situation:''' developing and executing KF5 apps under KDE 4.


Problem: After working a bit with KF5 applications your regular KDE icon theme might be changed from oxygen to breeze.
Problem: After working a bit with KF5 applications, your regular KDE icon theme might be changed from oxygen to breeze.


Solution: see https://forum.kde.org/viewtopic.php?f=67&t=25032: Open "Icons - KDE Control Module" and change the theme back to Oxygen.
Solution: see https://forum.kde.org/viewtopic.php?f=67&t=25032: Open "Icons - KDE Control Module" and change the theme back to Oxygen.
Line 286: Line 313:
== Get more help ==
== 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].  
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]].
 
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:


Feel free to join us by visiting #kdevelop on Freenode. A web-based client can be found here: https://kiwiirc.com/client/irc.freenode.org/kdevelop
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


= Alternative building methods =
= Alternative building methods =


== Kubuntu CI ==
== Kubuntu CI ==
[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.
[[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.


== Docker ==
== Docker ==
* [[/Alternatives | Build with docker]]
* [[/Alternatives | Build with docker]]

Revision as of 15:00, 6 September 2016

Build KDE Frameworks and Applications

Safety Precautions

Configuring your build environment is the single most important step in building KDE. 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 KDE 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 KDE/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. 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 manually. If you use these as provided then your KDE 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.

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. Optionally, you can build your own Qt5.

Follow this page to install the required dependencies.

Git remote prefix

Let's setup a "kde:" prefix for git commands. Add the following text to your ~/.gitconfig:

[url "git://anongit.kde.org/"]
   insteadOf = kde:
[url "ssh://[email protected]/"]
   pushInsteadOf = kde:

kdesrc-build

kdesrc-build is a user-space package manager. It is used to compile KDE-related projects from source, and to install them into a designated directory.

This guide assumes that

  • you want to install KDevelop inside your home directory,
  • you want to put sources, build and log files into separate subdirectories under ~/kde, as well as install everything to ~/kde/usr, and
  • you use a Linux system and are familiar with bash.

Make sure to adapt these steps to your needs.

Install kdesrc-build

Start off by installing kdesrc-build and creating a basic configuration file:

mkdir -p ~/kde/src
cd ~/kde/src
git clone kde:kdesrc-build
cd kdesrc-build
cp kdesrc-buildrc-kf5-sample ~/.kdesrc-buildrc

# Install a symlink of kdesrc-build to a location in PATH
mkdir ~/bin
ln -s $PWD/kdesrc-build ~/bin
export PATH=~/bin:$PATH

You will need to append the line export PATH=~/bin:$PATH to your ~/.bashrc so kdesrc-build is available in PATH whenever you open a terminal.


Configure kdesrc-build

Edit ~/.kdesrc-buildrc and replace /path/to/kdesrc-build/kf5-qt5-build-include with ~/kdesrc/kdesrc-build/kf5-qt5-build-include. Add ignore-kde-structure true and make-options -jN to the global section. Finally, point kdesrc-build to the correct source, build, log, and install directories.

global
  ...
  # Do not introduce an extra directory hierarchy
  ignore-kde-structure true

  # set the number of jobs to 5; this should usually
  # be (number-of-cpu-cores + 1)
  make-options      -j5

  # Stop kdesrc-build
  #stop-on-failure  true

  # Directory structure
  src-dir           ~/kde/src
  build-dir         ~/kde/src
  log-dir           ~/kde/log
  kdedir            ~/kde/usr
  ...
end global

Run kdesrc-build

To let kdesrc-build handle the compilation and installation of KDevelop and its (direct) dependencies, type

$ kdesrc-build --debug libkomparediff2 grantlee kdevplatform kdevelop-pg-qt kdevelop

The --debug parameter will give you the verbose output, all command invocations and compiler output. Helpful for trouble-shooting. If you want to compile and install indirect dependencies as well, make sure to add the --include-dependencies parameter as well.

Set up a script for preparing the environment

Copy and use these commands to a new file called ~/kde/.setup/env:

export KF5=~/kde/usr
export QTDIR=/usr  
export CMAKE_PREFIX_PATH=$KF5:$CMAKE_PREFIX_PATH  
export XDG_DATA_DIRS=$KF5/share:$XDG_DATA_DIRS:/usr/share  
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 some systems, like OpenSUSE)
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
PS1="(kdesrc) $PS1"

A guide for building Plasma 5 specifically on Ubuntu 14.04 LTS can be found here.

Run Kdevelop

Whenever you want to run a self-compiled KDevelop, you just have to do the following commands in terminal:

 $ source ~/kde/.setup/env
 $ kdevelop

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.

<<<  PACKAGES FAILED TO BUILD  >>>
libkomparediff2 - ~/kde/log/<build-date>/libkomparediff2/error.log  :-(

Inspect that log to figure out what's going on:

 $ cat ~/kde/log/<build-date>/libkomparediff2/error.log
CMake Error at CMakeLists.txt:5 (find_package):
  Could not find a package configuration file provided by "ECM" (requested
  version 0.0.9) with any of the following names:
   ECMConfig.cmake
   ecm-config.cmake
  Add the installation prefix of "ECM" to CMAKE_PREFIX_PATH or set "ECM_DIR"
  to a directory containing one of the above files.  If "ECM" provides a
  separate development package or SDK, be sure it has been installed.

In this case, the ECM (extra cmake modules) package is missing. Since ECM is a KDE Framework, this error would have been avoided by the --include-dependencies parameter mentioned above.

However, this might also happen with dependencies that kdesrc-build is not able to handle itself. In such cases, you have to install additional packages via your system package manager. Most distribution offer ways to determine which package contains the missing files.

For Ubuntu, you would head over to http://packages.ubuntu.com and search for the distro package providing a particular file (ECMConfig.cmake in this case). The package search reveals extra-cmake-modules being a hot candidate; to fix above error we simply install the package and the restart the build:

 $ apt-get install extra-cmake-modules
 $ kdesrc-build ...

The error should be gone now.

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

The following page details how to test Plasma.

Troubleshooting

Compilation: how to quickly solve build problems

Situation:

One or more modules fail to build via kdesrc-build (displayed in red font).

Steps to solve (in the given order):

The following steps assume the directory structure as proposed in the kdesrc-build guide above.

  1. You may not have all dependencies installed. Read the output to see what missing dependency it is complaining about, search for the corresponding package for your distro, and install it.
  2. Check the list of currently broken modules on the KDE build server.
  3. If you get a build failure, simple fix might be to delete the build folder for that module and try building it again.
  4. See Analyse and fix build errors.
  5. Delete ~/kde/build and ~/kde/usr. Run kdesrc-build again.
  6. Ask for help on IRC or some mailing list, see Communicating with the team.
  7. Check if there are changes in the build instructions: see History of this wiki page.
  8. Start over from scratch.

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.

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

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

Solution (not verified yet): As said in the article, run this command before starting the app itself:

 $ . ~/kde/.setup/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)

(added: 2014-Oct, verified: 2015-Feb)

Situation: developing and executing KF5 apps under KDE 4.

Problem: After working a bit with KF5 applications, your regular KDE icon theme might be changed from oxygen to breeze.

Solution: see https://forum.kde.org/viewtopic.php?f=67&t=25032: Open "Icons - KDE Control Module" and change the theme back to Oxygen.

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.

Docker