Difference between revisions of "Calligra/Building"

Jump to: navigation, search
(Build Calligra: Note that debugfull is problematic and most often not needed.)
(Calligra3 is now focus)
 
(123 intermediate revisions by 15 users not shown)
Line 1: Line 1:
These instructions are for Unix and similar operating systems. For Windows, see the [[Calligra/Building_Calligra_on_Windows|building Calligra on Windows]] page.
+
#REDIRECT [[Calligra/Building/3]]
 
 
= Preparation =
 
{{Warning|First, to avoid conflicting copies of software, '''make sure you do not have other copy of Calligra or KOffice''' either installed through the package manager of your distribution or installed in any other way. Calligra and KOffice are mutually exclusive!}}
 
 
 
{{Warning|Follow this guide as an ordinary user. Do not login as '''root'''!}}
 
 
 
== Recommended setup ==
 
Here is recommendation of a directory structure:
 
;$HOME/kde4/src/:source code
 
;$HOME/kde4/build/calligra:directory that Calligra will be built in
 
;$HOME/kde4/inst:directory that Calligra will be installed in
 
 
 
The ''build'' directory is needed because you cannot (or should not) build Calligra inside the source directory; the source and build directory have to be separated.
 
 
 
Create these directories with:
 
 
 
mkdir -p ~/kde4/src; mkdir -p ~/kde4/build; mkdir -p ~/kde4/inst
 
 
 
'''Advantages of this setup:'''
 
*It is possible to have different builds (e.g. with different options out of the same source code)
 
*[http://techbase.kde.org/Getting_Started/Increased_Productivity_in_KDE4_with_Scripts David Faure's scripts] can be used to make development easier. With those scripts "make" can be typed in the source directory and building will happen in the right (build) directory automatically.
 
 
 
Also, check the [http://techbase.kde.org/Getting_Started/Build/KDE4 Techbase instructions on setting up a build environment]. That contains some useful scripts and functions.
 
 
 
== Getting the source code ==
 
There are two most useful options:
 
#'''Get the source code for the latest stable version.'''
 
#'''Get the source code for the current development version.''' Needed to test, check and give feedback about features that is in development and have not been released yet.
 
 
 
If unsure pick the stable version.
 
 
 
=== Getting the source code for the latest stable version ===
 
 
 
The latest stable Calligra version is '''{{Calligra/Stable}}'''.
 
 
 
It can be downloaded as single archive file from http://download.kde.org/stable/calligra-latest/calligra-{{Calligra/Stable}}.tar.bz2
 
 
 
If you prefer, stable versions are also available on the git repository too. To get stable version x.y from git, first clone the repository (''git clone kde:calligra'') and switch to ''calligra/x.y'' branch (that's the notation). Full procedure of cloning is available in the [[#Get the source code for the development version|Get the source code for the development version]] section below.
 
 
 
The branch for the latest stable version is '''calligra/{{Calligra/StableBranch}}''' and it contains code updates for current minor stable release '''{{Calligra/Stable}}''' plus updates for the next minor stable (if there are any).
 
 
 
=== Get the source code for the development version ===
 
 
 
The latest development version of Calligra is '''{{Calligra/Unstable}}''' {{Calligra/Stage}}; developers always refer to it as to '''Master'''. Applications from ''Master'' should always compile and be reasonably stable. Calligra developers never place experimental features there. Once tested and released, ''Master'' becomes the new current stable version {{Calligra/UnstableBranch}}.
 
 
 
''TODO: Here we should explain local branches, staging and always-release-ready Master, if we have that setup.''
 
 
 
*'''Option 1: directly from git'''
 
 
 
To retrieve the source code from Git you have to use the following setup:
 
 
 
Add the following text to your ~/.gitconfig:
 
 
 
<nowiki>[url "git://anongit.kde.org/"]</nowiki>
 
    insteadOf = kde:
 
[url "ssh://[email protected]/"]
 
    pushInsteadOf = kde:
 
 
 
Then execute
 
 
 
$ git clone kde:calligra
 
 
 
By using the kde: prefix, read access will automatically happen over Git, and authenticated SSH is only required for pushes.
 
 
 
Note that pushing your changes will only work if you have a KDE developer identity (https://identity.kde.org/register.php).
 
 
 
The $HOME/kde4/src/calligra directory will be created regardless of the way how the source code has been downloaded.
 
 
 
*'''Option 2: download a repository tarball'''
 
 
 
Go to https://projects.kde.org/projects/calligra/repository. Press the "Tarball" button. Copy the url text and paste it on your command line. It will look like:
 
 
 
wget -c http://anongit.kde.org/calligra/calligra-latest.tar.gz
 
 
 
Unpack and cd into directory, then run
 
 
 
$ ./initrepo.sh
 
 
 
From now on, you can run
 
 
 
$ git pull
 
 
 
to update, or
 
 
 
$ git rebase origin/master
 
 
 
if you have local changes
 
 
 
 
 
*'''Option 3: if beta or rc version was released''', the source code for the latest beta can be found on KDE's ftp [ftp://ftp.kde.org/pub/kde/unstable/calligra-latest/ calligra-latest]. Uncompress the code so that $HOME/kde4/src/calligra is created.
 
 
 
=== Working with multiple versions ===
 
You will often want to have more than one build environment in parallel, for example if you want to work on both stable and unstable branches at the same time or several ''feature'' branches.
 
 
 
Recommended way is to use '''git-new-workdir''' tool. The solution is based on a single git repository clone multiplied to many separate source directories for each branch you wish to use, all without performing full clone (what consumes disk space and requires fetching each clone separately). It is explained in the Techbase article [http://techbase.kde.org/Development/Git/Configuration#Multiple_Work_Branches Multiple Work Branches] and you can find the script there.
 
 
 
Example commands to have code for both Calligra ''{{Calligra/UnstableBranch}}.x'' and ''master'' versions:
 
 
 
To get the ''master'' into <tt>$HOME/kde4/src/calligra</tt>:
 
$ git clone kde:calligra
 
 
 
Then, to get the Calligra ''{{Calligra/UnstableBranch}}.x'' into <tt>$HOME/kde4/src/calligra-{{Calligra/UnstableBranch}}</tt>:
 
$ git-new-workdir $HOME/kde4/src/calligra $HOME/kde4/src/calligra-{{Calligra/UnstableBranch}} calligra/{{Calligra/UnstableBranch}}
 
 
 
(which means ''git-new-workdir <original clone's directory> <new source directory> <branch name>'')
 
 
 
= Build requirements =
 
This section provides information about '''hard''' (required) and '''optional''' software packages needed to build the Calligra software.
 
 
 
== Hard dependencies ==
 
 
 
{{Note|'''A note for developers:''' to add (or remove) a hard dependency, an explanation of the reason, and possibly a discussion must be posted in advance on [email protected] The new dependency need to be packaged in the most widely used distributions (Debian, Fedora Core, OpenSuSE, (K)ubuntu). First try to make your new feature optional.}}
 
 
 
Following are the general must-have dependencies for Calligra (unless you really need to do otherwise, just install relevant binary packages):
 
* Qt 4.6.0 or newer
 
*kdelibs and kdelibs development files
 
**the minimal requirement is currently 4.3.0, any 4.3, 4.4 or 4.5 release packaged in your distribution is OK
 
**On opensuse the development package is called libkde4-devel; on Ubuntu and Debian it is called kdelibs5-dev. (TODO: add info for other distributions)
 
**Calligra should also build fine with either kdelibs from ''git'' repository (see [http://techbase.kde.org/Getting_Started/Build/KDE4 techbase] for an explanation on how to compile kdelibs from svn), needed for parts of Calligra build with the Mobile Frameworks Profile of the KDE platform (Calligra Words, Calligra Sheets, Calligra Stage, krita)
 
* kdebase/runtime 4.3 or newer
 
* cmake 2.6.2 or newer
 
* lcms 1.18 or newer
 
* libpng development package (libpng14-devel on opensuse, libpng-dev on Ubuntu/Debian)
 
** development packages for other libraries may be needed; on ubuntu/Debian these can be installed using 'apt-get build-dep kdelibs5'
 
 
 
For Calligra Sheets:
 
* libeigen 2.0
 
 
 
For Krita:
 
* libeigen 2.0
 
* libexiv2 >= 0.16
 
* libqimageblitz
 
 
 
For Stage:
 
* boost
 
 
 
For Kexi:
 
* sqlite3 and sqlite3-devel packages (package names can differ on various distributions), version >= 3.7.10
 
* icu, libicu and libicu-devel (unicode support)
 
 
 
== Optional dependencies ==
 
 
 
All optional dependencies are logged at the end of the cmake run, so it is easy to figure out what is missing. The buildsystem also reports what component will not be built because given missing dependency.
 
 
 
== Simplified installation of dependencies on various distributions ==
 
{{Note|Most distribution don't ship calligra yet, so you may replace it by "koffice" or "koffice2" in those command lines}}
 
*'''deb-based distributions (Debian, Ubuntu...):''' All the dependencies used for the packages can be installed by running
 
apt-get build-dep {packagename}
 
for instance on Ubuntu:
 
sudo apt-get build-dep calligra
 
 
 
*'''OpenSuSE:''' All the dependencies used for building Calligra can be installed by running:
 
zypper si -d calligra
 
 
 
*'''Fedora:''' All the dependencies used for building Calligra can be installed by running:
 
yum-builddep calligra
 
 
 
*'''ArchLinux:''' All the dependencies used for building Calligra can be installed by running:
 
<pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word">sudo pacman -S kdepimlibs eigen2 freetds kdegraphics-okular libgsf libwpd libwpg libwps libvisio pstoedit glew gsl cmake automoc4 boost libkdcraw libpqxx fftw opengtl lcms2</pre>
 
 
 
*'''Chakra:''' All the dependencies used for building Calligra can be installed by running:
 
<pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word">sudo pacman -S kdelibs kdepimlibs eigen freetds kdegraphics-okular kdeedu-marble xbase libgsf libwpd libwpg libwps libvisio pstoedit glew gsl cmake automoc4 libspnav libqtgtl boost libkdcraw libpqxx fftw opengtl docbook-xsl create-resources lcms2 qrencode libdmtx</pre>
 
 
 
= Build Calligra =
 
{{Note|It is '''not''' possible to build Calligra in the source directory. Set up your directories as described in the [[#Recommended_setup|Recommended setup]] section above}}
 
 
 
Type:
 
mkdir -p $HOME/kde4/build/calligra
 
mkdir -p $HOME/kde4/inst
 
cd $HOME/kde4/build/calligra
 
 
 
There is a bug in Qt 4.8.0 and 4.8.1 which crashes the textshape quite heavily. The bug is fixed in Qt 4.8.2. There is a patch avaliable for Qt and most distributions that ship calligra have included the patch in their QT. See [http://quickgit.kde.org/index.php?p=calligra.git&a=blob_plain&f=README.PACKAGERS README.PACKAGERS] for more information on the topic. If you have applied the patch here is the cmake command you need to use so all gets build:
 
 
 
cmake -DCMAKE_INSTALL_PREFIX=$HOME/kde4/inst $HOME/kde4/src/calligra \
 
      -DCMAKE_BUILD_TYPE=RelWithDebInfo -DIHAVEPATCHEDQT=true
 
 
 
Otherwise type the command without the IHAVEPATCHEDQT flag:
 
 
 
cmake -DCMAKE_INSTALL_PREFIX=$HOME/kde4/inst $HOME/kde4/src/calligra \
 
      -DCMAKE_BUILD_TYPE=RelWithDebInfo
 
 
 
''cmakekde'' tool can be used as explained on [http://techbase.kde.org/Getting_Started/Build/KDE4 the build instructions for KDE4].
 
 
 
Then type:
 
make
 
 
 
Note that on dual-core machines compilation can be '''greatly speed up''' with the -j parameter of the ''make'' program, for example for dual-core:
 
make -j4
 
and for quad-core:
 
make -j8
 
 
 
Then type this command to install the software:
 
make install
 
 
 
'''Debugging options.''' The default debug setting is <tt>RelWithDebInfo</tt> which is suitable for most developers. If you are debugging an application and cannot trace the codew, you can  set CMAKE_BUILD_TYPE to <tt>"DebugFull"</tt> to get a slower Calligra but with even more verbose debugging (backtrace) information. For this replace ''-DCMAKE_BUILD_TYPE=RelWithDebInfo'' in the above cmake command with ''-DCMAKE_BUILD_TYPE=DebugFull''.  However, all Calligra applications will crash on closing with this option enabled.
 
 
 
If you are working on Krita, use the <tt>KritaDevs</tt> option always.
 
 
 
Please follow the [[Calligra/Building#Running_Calligra_applications|Running Calligra Applications]] instructions before trying to run an application.
 
 
 
= Updating the already built software =
 
If the source code has been cloned using Git, it is possible to update the source code with newly added changes and build again. Usually only changing parts will be built, so this operation would be faster than building the source code from scratch.
 
 
 
Type:
 
cd $HOME/kde4/src/calligra
 
git pull --rebase
 
cd $HOME/kde4/build/calligra
 
make
 
make install
 
 
 
{{Note|''make -j4'' or ''make -j8'' can be used instead of ''make'' to speedup the build on multicore machines}}
 
 
 
= Build only selected applications from Calligra =
 
 
 
If you only want to build Krita, pass
 
 
 
-DCREATIVEONLY=ON
 
 
 
on the cmake command line.
 
 
 
If you know what you are doing, you can enable and disable specific applications with ccmake:
 
 
 
CMake comes with a command-line tool ''ccmake'' that lets you configure build options. You can use it after executing cmake and ''before'' executing make. To use it, go to the build directory and issue the following commands:
 
cd $HOME/kde4/build/calligra
 
ccmake .
 
''ccmake'' is a text user interface application. Simple usage: move the selection using up/down arrow keys. Press Enter to set option ON/OFF (for text options, you enter the text). When you're done with setting the options, press c key to configure the source code to apply your changes. When done, press e key to exit. At any time you can press Ctrl+C to stop the application without saving your changes. Any change is saved to $HOME/kde4/build/calligra/CMakeCache.txt file. You can remove this file to get back to the default configuration (in this case you have to re-execute cmake first.
 
 
 
For applications that you do '''not''' want to compile, set the corresponding BUILD_{application} variable to "off", replacing {application} by the app's name. For instance, setting ''BUILD_krita'' to ''off'' will prevent Krita from being built.
 
 
 
Alternatively you can run "-DBUILD_{application}=off" from the cmake command line.
 
 
 
However: there are many BUILD_something options that you should not turn off unless you know what you are doing!
 
 
 
= Running Calligra applications =
 
There are two options to make the Calligra applications available for running.
 
 
 
*'''Option 1: Being able to run Calligra applications from the command line.''' If you have installed Calligra in a different prefix than KDElibs (which was recommended in this document), you have to set the following environment variables:
 
 
 
export KDEDIRS=/path/to/install:$KDEDIRS
 
export PATH=/path/to/install/bin:$PATH
 
export KDEHOME=/path/to/a/config/dir
 
 
 
And then you need to execute:
 
kbuildsycoca4
 
 
 
For example for the recommended directory structure:
 
export KDEDIRS=$HOME/kde4/inst:$KDEDIRS
 
export PATH=$HOME/kde4/inst/bin:$PATH
 
export KDEHOME=$HOME/kde4/.kde
 
 
 
It is important to set KDEHOME to a directory different of $HOME/.kde, and if the directory does not exist, it will be created automatically.
 
 
 
*'''Option 2: Being able to run Calligra applications from the menu or by clicking on desktop icons.''' Instead of using ''KDEDIRS'', you can add these lines to $HOME/.kde/share/config/kdeglobals file using text editor:
 
 
 
[Directories]
 
prefixes=/path/to/install
 
 
 
And then you need to execute:
 
kbuildsycoca4
 
 
 
The advantage of this is that KDE4 will always look for the services where Calligra is installed.
 
For example for the recommended directory structure:
 
 
 
[Directories]
 
prefixes=$HOME/kde4/inst.
 
 
 
= Executing unit tests =
 
To be able to execute unit tests, you need to explicitely enable them in the build configuration. To do so, set the KDE4_BUILD_TESTS variable to "ON", either by issuing the command in the build directory:
 
 
 
cd $HOME/kde4/build/calligra
 
cmake -DKDE4_BUILD_TESTS=ON .
 
 
 
Or you can run <code>ccmake .</code> in the buld directory and set KDE4_BUILD_TESTS to "on".
 
 
 
You can then run the test by executing:
 
 
 
make test
 
 
 
or individually in the tests directories.
 
 
 
It is recommended to execute
 
 
 
make install
 
 
 
before running tests.
 
 
 
= CMake Build Options =
 
When you enter your build directory, you can type "ccmake ." to see many build options, e.g. you can turn off compilation of apps you don't want - you can save time when compiling.
 
 
 
Here is list for Krita related options:
 
* HAVE_MEMORY_LEAK_TRACKER [On/Off] - You can turn on compilation of the tool in krita which detects memory leak. If you want to help debug Krita memory usage, it is useful. Otherwise you just slow down your Krita.
 
* HAVE_BACKTRACE_SUPPORT [On/Off] - It is related to the memory leak tool. If you activate, you will be able to see code path which leads to memory leak.
 
 
 
= Resources =
 
*[[DeveloperInfo|Useful hints for who wants to hack on Calligra]]
 
*[http://wiki.opengtl.org/libraries:developers-resources opengtl debugging, or turning it off]
 
*[http://winkde.org/pub/kde/ports/win32/dashboard/ Status of Calligra build on Windows (msvc 2008, mingw)]
 
 
 
= Possible issues =
 
 
 
If you get errors when running an application like:
 
 
 
krita(8565)/calligra (lib komain) KoPluginLoader::load: Loading plugin "Animation Tool" failed,
 
"Cannot load library /home/michael/kde4/inst/lib/kde4/kpresentertoolanimation.so:
 
(/home/michael/kde4/inst/lib/libkopageapp.so.7: undefined symbol:
 
_ZN28KoShapeContainerDefaultModel3addEP7KoShape)" ( 1 )
 
 
 
or crashes when starting an application, then you very likely have a version of Calligra installed through your package manager. '''As emphasized earlier in this document, you can only have one version of Calligra, and you should uninstall your packaged Calligra'''.
 
 
 
See also:
 
*[[/Nightly Builds/]]
 
*[[/Developing With KDevelop/]]
 
*[[/Developing With QtCreator/]]
 
*[http://techbase.kde.org/Projects/KDE_on_Windows Pages about compiling KDE software for Windows]
 
*[http://techbase.kde.org/Getting_Started/Build/KDE4/Mac_OS_X Pages about compiling KDE software for Mac OS X]
 
*[https://wiki.kubuntu.org/CompilingKoffice2 Community HOWTO dedicated to building for Kubuntu]
 
*[http://community.kde.org/Sysadmin/GitKdeOrgManual kde's git infrastructure manual]
 
*[http://techbase.kde.org/Development/Tutorials/Git KDE and Git for developers]
 
*[http://git.or.cz/course/svn.html git crash course]
 
*[http://forum.kde.org/viewtopic.php?f=139&t=92880 script for building Calligra (build only krita by default, but easilly configurable)]
 
*[http://community.kde.org/Calligra/Building_Calligra_on_Windows Bulding Calligra on Windows]
 
 
 
Note: if you want to build FreOffice using the Nokia Qt SDK, please check out the [http://techbase.kde.org/index.php?title=User:Kumarafaque&oldid=54703 build instructions on techbase].
 

Latest revision as of 11:49, 2 July 2016


This page was last edited on 2 July 2016, at 11:49. Content is available under Creative Commons License SA 4.0 unless otherwise noted.