m (Build Calligra)
Line 131: Line 131:
 
* We are building to the same type (RelWithDebInfo / Debug) as used to build the Qt and KDE libraries, by reading the value of ''EMERGE_BUILDTYPE''
 
* We are building to the same type (RelWithDebInfo / Debug) as used to build the Qt and KDE libraries, by reading the value of ''EMERGE_BUILDTYPE''
 
* We are selectively disabling some portions of the build with the -DBUILD_xxxx=on|off commands. 'active' and 'mobile' are not applicable to the desktop build, while flow and kexi (at the time of writing) were still undergoing testing on the platform.
 
* We are selectively disabling some portions of the build with the -DBUILD_xxxx=on|off commands. 'active' and 'mobile' are not applicable to the desktop build, while flow and kexi (at the time of writing) were still undergoing testing on the platform.
 +
 +
 +
{{Note|You can selectively build applications by using the <nowiki>-DBUILD_application=off</nowiki> command to disable building of those you do not want. If you have a full cmake install, you can use the ''<nowiki>cmake-gui</nowiki>'' application to let you make changes to the configuration.}}
  
 
Then, to build Calligra, type:
 
Then, to build Calligra, type:
Line 136: Line 139:
  
 
{{Note|''jom'' is a multi-core port of ''nmake''. By default it uses all of the cores on the machine, buy you can specify the number to use with the ''-j#'' parameter. e.g. ''jom -j2'' would force it to use 2 processes}}
 
{{Note|''jom'' is a multi-core port of ''nmake''. By default it uses all of the cores on the machine, buy you can specify the number to use with the ''-j#'' parameter. e.g. ''jom -j2'' would force it to use 2 processes}}
 +
  
 
This will take a while, once it has completed, type this command to install the software:
 
This will take a while, once it has completed, type this command to install the software:
Line 145: Line 149:
  
 
Please follow the [[Building/Building_Calligra#Running_Calligra_applications|Running Calligra Applications]] instructions before trying to run an application.
 
Please follow the [[Building/Building_Calligra#Running_Calligra_applications|Running Calligra Applications]] instructions before trying to run an application.
 
= Updating the already built software =
 
If the source code has been checked out, 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 <nowiki>%USERPROFILE%\kde4\src\calligra</nowiki>
 
git pull
 
cd <nowiki>%USERPROFILE%\kde4\build\calligra</nowiki>
 
jom
 
jom install
 
 
= Build only selected applications from Calligra =
 
<!--
 
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/don 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.
 
-->
 
You can edit the cmake command line, with "-DBUILD_{application}=off" from the cmake command line.
 
 
 
= Running Calligra applications =
 
= Running Calligra applications =
 
There are two options to make the Calligra applications available for running.
 
There are two options to make the Calligra applications available for running.
Line 196: Line 178:
  
 
The advantage of this is that KDE4 will always look for the services where Calligra is installed.
 
The advantage of this is that KDE4 will always look for the services where Calligra is installed.
 +
 +
 +
= Updating the already built software =
 +
If the source code has been checked out, 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 <nowiki>%USERPROFILE%\kde4\src\calligra</nowiki>
 +
git pull
 +
cd <nowiki>%USERPROFILE%\kde4\build\calligra</nowiki>
 +
jom
 +
jom install
 +
 +
<!--
 +
= Build only selected applications from Calligra =
 +
 +
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/don 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.
 +
 +
You can edit the cmake command line, with "-DBUILD_{application}=off" from the cmake command line.
 +
-->
  
 
= Executing unit tests =
 
= Executing unit tests =

Revision as of 15:29, 15 December 2011

Note
These instructions are a work in progress, being based on the Linux Build instructions, there are some sections which need updating.


These instructions are for Unix and similar operating systems.

See also:


Preparation

Before you begin, you will need to have a minimal set of software installed on your PC:

  • Python 2.7 (x86, not 64-bit)
  • Microsoft Visual Studio 2010 Express or Professional
  • Microsoft Windows SDK 7.1 (Windows 7 with .NET Framework 4)
  • KDE on Windows' emerge tool

The following instructions assume that you have installed emerge, have a valid kdesettings.bat file in KDEROOT/etc, and that you have kdeenv from KDEROOT/emerge. In order to install the bare minimum set up of KDE libraries, you will need to run a series of calls to emerge, which will take some time:

emerge qt
emerge kdelibs
emerge kde-runtime

Users familiar with development on Linux platforms may also wish to install another couple of libraries

emerge corelibs
emerge grep

There are some additional libraries required by Calligra, again emerge is used to install them:

emerge lcms
emerge eigen2
emerge boost
emerge okular
emerge exiv2

Recommended setup

Here is recommendation of a directory structure:

C:\kderoot
KDE on Windows root directory

From your %USERPROFILE% directory (assuming you will be the only local user)

kde4\src\
source code
kde4\build\calligra
directory that Calligra will be built in
kde4\inst\
directory that Calligra will be installed in

The build directory is needed because you cannot build Calligra inside the source directory; the source and build directory have to be separated.

You can create this structure by opening a command prompt (cmd.exe) and typing:

cd %USERPROFILE% 
mkdir kde4
mkdir kde4\build
mkdir kde4\build\calligra
mkdir kde4\inst
mkdir kde4\src

Getting the source code

As Windows support is still being improved, it is recommended that you use the development version. If you require stability, it is recommended that you take advantage of the nightly builds.

The latest development version of Calligra is 3.1.0 Alpha; developers always refer to it as to Master. Once tested and released, it will become the new current stable version 3.1.


To retrieve the source code from Git you have to use the following setup:

Add the following text to %USERPROFILE%\.gitconfig:

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

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

This will create a 'calligra' subdirectory with the complete source tree.

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:

  • 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
  • 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)

For Tables:

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

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 bot be built because given missing dependency. Use emerge to install these missing dependencies (not all may be available on the Windows platform).


Build Calligra

From your home directory, navigate to the build\calliga subdirectory and execute cmake to configure the project for building with the following lines:

cd kde4\build\calligra</nowiki>
cmake -DCMAKE_INSTALL_PREFIX=..\..\inst ..\..\src\calligra -DCMAKE_BUILD_TYPE=%EMERGE_BUILDTYPE% -DTINY=off -DBUILD_active=off -DBUILD_mobile=off -DBUILD_flow=off -DBUILD_kexi=off

Here we are telling cmake that:

  • We want to install Calligra into ~/kde4/inst
  • The source files are located at ~/kde4/src/calligra
  • We are building to the same type (RelWithDebInfo / Debug) as used to build the Qt and KDE libraries, by reading the value of EMERGE_BUILDTYPE
  • We are selectively disabling some portions of the build with the -DBUILD_xxxx=on|off commands. 'active' and 'mobile' are not applicable to the desktop build, while flow and kexi (at the time of writing) were still undergoing testing on the platform.


Note
You can selectively build applications by using the -DBUILD_application=off command to disable building of those you do not want. If you have a full cmake install, you can use the cmake-gui application to let you make changes to the configuration.


Then, to build Calligra, type:

jom
Note
jom is a multi-core port of nmake. By default it uses all of the cores on the machine, buy you can specify the number to use with the -j# parameter. e.g. jom -j2 would force it to use 2 processes


This will take a while, once it has completed, type this command to install the software:

jom  install


Please follow the Running Calligra Applications instructions before trying to run an application.

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 may want to set the following environment variable:
set KDEDIRS=\path\to\install;%KDEDIRS%
set PATH=\path\to\install\bin;%PATH%
set KDEHOME=\path\to\a\config\dir

And then you need to execute:

kbuildsycoca4

For example for the recommended directory structure:

set KDEDIRS=%USERPROFILE%\kde4\inst;%KDEDIRS%
set PATH=%USERPROFILE%\kde4\inst\bin;%PATH%
set KDEHOME=%USERPROFILE%\kde4\.kde

Here we are setting KDEHOME to be saved

  • 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=%USERPROFILE%\kde4\inst

And then you need to execute:

update-mime-database %KDEROOT%\share\mime
kbuildsycoca4 --noincremental

The advantage of this is that KDE4 will always look for the services where Calligra is installed.


Updating the already built software

If the source code has been checked out, 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 %USERPROFILE%\kde4\src\calligra
git pull
cd %USERPROFILE%\kde4\build\calligra
jom
jom install


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 XXX ccmake . XXX in the buld directory and set KDE4_BUILD_TESTS to "on".

It is then recommended that before running the tests, you first execute

jom install

You can then run the test by executing:

jom test

or individually in the tests directories.

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

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.


Content is available under Creative Commons License SA 4.0 unless otherwise noted.