Difference between revisions of "Calligra/Building Calligra on Windows"

Jump to: navigation, search
(Running Calligra applications)
(Executing unit tests)
 
(73 intermediate revisions by 13 users not shown)
Line 1: Line 1:
 +
[[../Building|« Back to general building instructions]]
 +
 
{{Note|''These instructions are a work in progress, being based on the Linux Build instructions, there are some sections which need updating.''}}
 
{{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.
+
These instructions are for the Windows operating systems.
  
 
See also:
 
See also:
 +
* Building Krita on Windows, the easy way [[/BuildKritaOnWindows/]]
 
*Nightly Builds <!-- [[/Nightly Builds/]] -->
 
*Nightly Builds <!-- [[/Nightly Builds/]] -->
 
*Developing With...<!--[[/Developing With QtCreator/]]-->
 
*Developing With...<!--[[/Developing With QtCreator/]]-->
Line 17: Line 20:
  
 
= Preparation =
 
= Preparation =
Before you begin, you will need to have a minimal set of software installed on your PC:
+
== Automated Approach ==
* Python 2.7 (x86, not 64-bit)
+
First you should have windows 7 or later installed.
* Microsoft Visual Studio 2010 Express or Professional
+
If you're a unix user and tired of install windows manually, here is a sample packer template for auto-unattend installation of Windows 7 SP1 x64 in virtualbox:
* Microsoft Windows SDK 7.1 (Windows 7 with .NET Framework 4)
+
<pre>
* KDE on Windows' ''emerge'' tool
+
git clone https://github.com/philacs/calligra-windows-dev-env-setup.git
 +
cd calligra-windows-dev-env-setup
 +
</pre>
 +
replace <code>ProductKey</code> and <code>Windows 7 PROFESSIONAL</code> in <code>scripts/Autounattend.xml</code> to use your ProductKey and Edition, replace <code>"iso_url"</code> in <code>win7x64.json</code> to the location of your windows 7 iso file. <code>kde</code> folder will be copied to <code>C:/kde</code> so put anything you want to copy there. Install packer following [http://www.packer.io/intro/getting-started/setup.html this link], make sure your computer connected to the Internet so it can download needed softwares, then
 +
<pre>
 +
packer build win7x64.json
 +
</pre>
 +
Virtualbox Appliance files will be generated under <code>output-virtualbox-iso</code> folder, import the ovf file in virtualbox to use it.
 +
 
 +
If you don't use the packer.io builder provided, still [https://github.com/philacs/calligra-windows-dev-env-setup/archive/master.zip download the git repo] and copy <code>kderoot</code> folder as <code>C:/kderoot</code> manually to continue next step.
  
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:
+
Now download and install kde windows build dependencies. Run<code>C:/kderoot/install-kde-build-deps.bat</code>, an application will be downloaded through IE and click "Run" in the upcoming dialog, then the install starts. The installation is automated including reboot handling, wait until everything finish.
emerge qt
 
emerge kdelibs
 
emerge kde-runtime
 
  
Users familiar with development on Linux platforms may also wish to install another couple of libraries
+
[TODO] Download pre-built calligra dependencies by running <code>C:/kderoot/install-calligra-build-deps.bat</code>.
emerge corelibs
 
emerge grep
 
  
There are some additional libraries required by Calligra, again ''emerge'' is used to install them:
+
== Manual Approach ==
emerge lcms
 
emerge eigen2
 
emerge boost
 
emerge okular
 
emerge exiv2
 
  
== Recommended setup ==
+
=== Setup Directories ===
Here is recommendation of a directory structure:
+
Here is standard directory structure for building KDE applications:
 
;<nowiki>C:\kderoot</nowiki>:KDE on Windows root directory
 
;<nowiki>C:\kderoot</nowiki>:KDE on Windows root directory
  
From your %USERPROFILE% directory (assuming you will be the only local user)
+
From your %USERPROFILE% directory (assuming you are the only local user)
 
;kde4\src\:source code
 
;kde4\src\:source code
 
;kde4\build\calligra:directory that Calligra will be built in
 
;kde4\build\calligra:directory that Calligra will be built in
 
;kde4\inst\:directory that Calligra will be installed 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:
 
You can create this structure by opening a command prompt (cmd.exe) and typing:
Line 57: Line 57:
 
  mkdir kde4\inst
 
  mkdir kde4\inst
 
  mkdir kde4\src
 
  mkdir kde4\src
 +
 +
 +
=== Install Dependencies ===
 +
Before you begin, you will need to have a minimal set of software installed on your PC:
 +
* '''Python 3.4 (x86, not 64-bit)'''
 +
* '''Git'''
 +
* '''Microsoft Windows SDK 7.1 with Service Pack 1'''  ([http://blogs.msdn.com/b/vcblog/archive/2011/03/31/10148110.aspx Instructions are here.])
 +
 +
 +
This assumes you want to use MSVC2010.  These two posts [[http://mail.kde.org/pipermail/kde-windows/2014-August/008886.html]] and [[http://mail.kde.org/pipermail/kde-windows/2014-August/008887.html]] are about using kde-4.12 with MSVC2013.
 +
 +
===Configure Emerge===
 +
"emerge" is a Python-based set of scripts which download and build a lot of software KDE depends on. When it works properly emerge very convenient to use, however it must be configured with care. [https://techbase.kde.org/Getting_Started/Build/Windows/emerge You can learn more about emerge here].
 +
 +
Begin by downloading the emerge repository.
 +
 +
git clone git://anongit.kde.org/emerge.git
 +
cd emerge
 +
git checkout kde-4.13
 +
mkdir ..\etc
 +
copy kdesettings-example.bat ..\etc\kdesettings.bat
 +
(Note: the instructions below use the kde-4.13 branch.  However the author never had success with kde-4.13 and MSVC2013, so perhaps kde-4.12 would be the better choice.)
 +
 +
Next you must tell emerge about your build environment.  To do this you will need to make the following changes to etc/kdesettings.bat:
 +
* Update KDEROOT
 +
* Set KDECOMPILER=msvc2010 (or msvc2012 or msvc2013)
 +
* Set EMERGE_USE_SHORT_PATH=True
 +
* Set EMERGE_PYTHON_PATH to your Python installation(default assumes in Program Files)
 +
* Update WINDOWSSDKDIR to point to your installation of the Windows SDK
 +
* Set EMERGE_SOURCEONLY=True
 +
 +
When using MS Visual Studio 2010, make sure you have SP1. MS VS 2012 and 2013 may have problems compiling Qt 4.8.5 (see [http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/install_win.html] and [http://stackoverflow.com/questions/12113400/compiling-qt-4-8-x-for-visual-studio-2012] for details).
 +
 +
One you have done this, you should navigate to the emerge directory and call
 +
kdeenv
 +
 +
This sets up the development environment that you will need to use in order to build the KDE libraries, their dependencies and Calligra.
 +
 +
===Emerge KDE libraries===
 +
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
 +
emerge boost (required for required for the core libraries, stage, sheets and krita)
 +
 +
 +
 +
Users familiar with development on Linux platforms may also wish to install another couple of libraries
 +
emerge coreutils
 +
emerge grep
 +
 +
There are some additional optional libraries that can be used by Calligra, again ''emerge'' is used to install them:
 +
emerge lcms2
 +
emerge eigen2
 +
emerge okular (only needed to build a calligra plugin for okular)
 +
emerge exiv2
 +
emerge soprano
 +
emerge librdf-src
 +
 +
Wordperfect document and graphics support is contained in two additional libraries:
 +
emerge libwpd
 +
emerge libwpg
  
 
== Getting the source code ==
 
== Getting the source code ==
Line 77: Line 139:
 
Then execute
 
Then execute
  
  $ git clone kde:calligra
+
  git clone kde:calligra
  
 
By using the kde: prefix, read access will automatically happen over Git, and authenticated SSH is only required for pushes.
 
By using the kde: prefix, read access will automatically happen over Git, and authenticated SSH is only required for pushes.
Line 84: Line 146:
  
 
This will create a 'calligra' subdirectory with the complete source tree.
 
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).
 
 
<!-- include simplified distribution info -->
 
  
 
= Build Calligra =
 
= 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:
 
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>
+
  cd kde4\build\calligra
  cmake -DCMAKE_INSTALL_PREFIX=<nowiki>..\..\inst</nowiki> <nowiki>..\..\kde4\src\calligra</nowiki> -DCMAKE_BUILD_TYPE=%EMERGE_BUILDTYPE% -DTINY=off -DBUILD_active=off -DBUILD_mobile=off -DBUILD_flow=off -DBUILD_kexi=off
+
# with versions <= 2.6
 +
  cmake -DCMAKE_INSTALL_PREFIX=<nowiki>..\..\inst</nowiki> <nowiki>..\..\src\calligra</nowiki> -DCMAKE_BUILD_TYPE=%EMERGE_BUILDTYPE% -G "NMake Makefiles JOM" -DTINY=off -DBUILD_active=off -DBUILD_mobile=off -DBUILD_kexi=off
 +
# with versions >= 2.7
 +
cmake -DCMAKE_INSTALL_PREFIX=<nowiki>..\..\inst</nowiki> <nowiki>..\..\src\calligra</nowiki> -DCMAKE_BUILD_TYPE=%EMERGE_BUILDTYPE% -G "NMake Makefiles JOM" -DBUILD_kexi=off
  
 
Here we are telling cmake that:
 
Here we are telling cmake that:
Line 131: Line 160:
 
* 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:
  jom
+
  jom -j 20
 +
 
 +
{{Note|''jom'' is a multi-core port of ''nmake''. You can specify the number of course use with the ''-j#'' parameter. e.g. ''jom -j8'' would instruct it to use 8 processes.  Setting a large number will instruct it to use all the cores on your machine.}}
  
{{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:
  jom install
+
  jom install
  
 
<!-- Including "build debug" info
 
<!-- Including "build debug" info
Line 144: Line 177:
 
-->
 
-->
  
Please follow the [[Building/Building_Calligra#Running_Calligra_applications|Running Calligra Applications]] instructions before trying to run an application.
+
Please follow the [[Calligra/Building_Calligra_on_Windows#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 =
Line 184: Line 196:
 
  set KDEHOME=%USERPROFILE%\kde4\.kde
 
  set KDEHOME=%USERPROFILE%\kde4\.kde
  
Here we are setting KDEHOME to be saved  
+
Here we are setting KDEHOME to be saved.
 +
 
 +
If you are using Windows Powershell, the commands are:
 +
$KDEDIRS = $KDEDIRS + ";\path\to\install"
 +
$Path = $Path + ";\path\to\install\bin"
 +
$KDEHOME = $KDEHOME + "\path\to\a\config\dir"
  
 
*'''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:
 
*'''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:
Line 196: Line 213:
  
 
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 --rebase
 +
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 =
 
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:
 
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
+
  cd %USERPROFILE%/kde4/build/calligra
 
  cmake -DKDE4_BUILD_TESTS=ON .
 
  cmake -DKDE4_BUILD_TESTS=ON .
  
Or you can run XXX <code>ccmake .</code> XXX in the buld directory and set KDE4_BUILD_TESTS to "on".
+
Or you can run cmake-gui in the buld directory and set KDE4_BUILD_TESTS to "on".
  
 
It is then recommended that before running the tests, you first execute
 
It is then recommended that before running the tests, you first execute
Line 216: Line 256:
  
 
= CMake Build Options =
 
= 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.
+
When you enter your build directory, you can type "cmake-gui ." 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:
 
Here is list for Krita related options:
Line 229: Line 269:
 
= Possible issues =
 
= Possible issues =
  
 +
== Calligra apps don't start ==
 +
 +
If the Calligra applications do not start properly, or you see the window flash up then disappear, then you need to check the [[#Running_Calligra_applications|Running Calligra Applications]] section earlier and make sure you've run update-mime-database and kbuildsycoca4.
 +
 +
You can get some additional insight by installing DebugView, which will let you see warnings and error messages reported by the programs.
 +
This is available on [http://technet.microsoft.com/en-us/sysinternals/bb896647 Microsoft Technet].
 +
 +
<!--
 
If you get errors when running an application like:
 
If you get errors when running an application like:
  
Line 237: Line 285:
  
 
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'''.
 
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'''.
 +
-->
 +
The sources for the WIX-based installer for Calligra on Windows are at https://gitorious.org/calligra-installer-for-windows

Latest revision as of 02:33, 27 June 2015

« Back to general building instructions

Note-box-icon.png
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 the Windows operating systems.

See also:


Preparation

Automated Approach

First you should have windows 7 or later installed. If you're a unix user and tired of install windows manually, here is a sample packer template for auto-unattend installation of Windows 7 SP1 x64 in virtualbox:

git clone https://github.com/philacs/calligra-windows-dev-env-setup.git
cd calligra-windows-dev-env-setup

replace ProductKey and Windows 7 PROFESSIONAL in scripts/Autounattend.xml to use your ProductKey and Edition, replace "iso_url" in win7x64.json to the location of your windows 7 iso file. kde folder will be copied to C:/kde so put anything you want to copy there. Install packer following this link, make sure your computer connected to the Internet so it can download needed softwares, then

packer build win7x64.json

Virtualbox Appliance files will be generated under output-virtualbox-iso folder, import the ovf file in virtualbox to use it.

If you don't use the packer.io builder provided, still download the git repo and copy kderoot folder as C:/kderoot manually to continue next step.

Now download and install kde windows build dependencies. RunC:/kderoot/install-kde-build-deps.bat, an application will be downloaded through IE and click "Run" in the upcoming dialog, then the install starts. The installation is automated including reboot handling, wait until everything finish.

[TODO] Download pre-built calligra dependencies by running C:/kderoot/install-calligra-build-deps.bat.

Manual Approach

Setup Directories

Here is standard directory structure for building KDE applications:

C:\kderoot
KDE on Windows root directory

From your %USERPROFILE% directory (assuming you are 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

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


Install Dependencies

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


This assumes you want to use MSVC2010. These two posts [[1]] and [[2]] are about using kde-4.12 with MSVC2013.

Configure Emerge

"emerge" is a Python-based set of scripts which download and build a lot of software KDE depends on. When it works properly emerge very convenient to use, however it must be configured with care. You can learn more about emerge here.

Begin by downloading the emerge repository.

git clone git://anongit.kde.org/emerge.git
cd emerge
git checkout kde-4.13
mkdir ..\etc
copy kdesettings-example.bat ..\etc\kdesettings.bat

(Note: the instructions below use the kde-4.13 branch. However the author never had success with kde-4.13 and MSVC2013, so perhaps kde-4.12 would be the better choice.)

Next you must tell emerge about your build environment. To do this you will need to make the following changes to etc/kdesettings.bat:

  • Update KDEROOT
  • Set KDECOMPILER=msvc2010 (or msvc2012 or msvc2013)
  • Set EMERGE_USE_SHORT_PATH=True
  • Set EMERGE_PYTHON_PATH to your Python installation(default assumes in Program Files)
  • Update WINDOWSSDKDIR to point to your installation of the Windows SDK
  • Set EMERGE_SOURCEONLY=True

When using MS Visual Studio 2010, make sure you have SP1. MS VS 2012 and 2013 may have problems compiling Qt 4.8.5 (see [3] and [4] for details).

One you have done this, you should navigate to the emerge directory and call

kdeenv

This sets up the development environment that you will need to use in order to build the KDE libraries, their dependencies and Calligra.

Emerge KDE libraries

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
emerge boost (required for required for the core libraries, stage, sheets and krita)


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

emerge coreutils
emerge grep

There are some additional optional libraries that can be used by Calligra, again emerge is used to install them:

emerge lcms2
emerge eigen2
emerge okular (only needed to build a calligra plugin for okular)
emerge exiv2
emerge soprano
emerge librdf-src

Wordperfect document and graphics support is contained in two additional libraries:

emerge libwpd
emerge libwpg

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 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
# with versions <= 2.6
cmake -DCMAKE_INSTALL_PREFIX=..\..\inst ..\..\src\calligra -DCMAKE_BUILD_TYPE=%EMERGE_BUILDTYPE% -G "NMake Makefiles JOM" -DTINY=off -DBUILD_active=off -DBUILD_mobile=off -DBUILD_kexi=off
# with versions >= 2.7
cmake -DCMAKE_INSTALL_PREFIX=..\..\inst ..\..\src\calligra -DCMAKE_BUILD_TYPE=%EMERGE_BUILDTYPE% -G "NMake Makefiles JOM" -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-box-icon.png
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 -j 20
Note-box-icon.png
Note
jom is a multi-core port of nmake. You can specify the number of course use with the -j# parameter. e.g. jom -j8 would instruct it to use 8 processes. Setting a large number will instruct it to use all the cores on your machine.


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.

If you are using Windows Powershell, the commands are:

$KDEDIRS = $KDEDIRS + ";\path\to\install"
$Path = $Path + ";\path\to\install\bin"
$KDEHOME = $KDEHOME + "\path\to\a\config\dir"
  • 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 --rebase
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 %USERPROFILE%/kde4/build/calligra
cmake -DKDE4_BUILD_TESTS=ON .

Or you can run cmake-gui 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 "cmake-gui ." 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

Calligra apps don't start

If the Calligra applications do not start properly, or you see the window flash up then disappear, then you need to check the Running Calligra Applications section earlier and make sure you've run update-mime-database and kbuildsycoca4.

You can get some additional insight by installing DebugView, which will let you see warnings and error messages reported by the programs. This is available on Microsoft Technet.

The sources for the WIX-based installer for Calligra on Windows are at https://gitorious.org/calligra-installer-for-windows


This page was last edited on 27 June 2015, at 02:33. Content is available under Creative Commons License SA 4.0 unless otherwise noted.