Getting Started/Build/KDE4 (fr)

(La traduction en français est en cours, n'hésitez pas à apporter votre contribution. La page originelle en anglais est ici : Getting Started/Build/KDE4)

Building KDE4 From Source

Tutorial Series	Démarrer avec KDE
Previous	Anonymous SVN Quickstart Guide
What's Next	Set up KDE 4 for development
Further Reading	kdesvn-build: The KDE From Subversion Build Tool Increased Productivity in KDE4 with Scripts Introduction to CMake FreeBSD notes Instructions for Mac OS X

Résumé

Ce tutoriel détaille une procédure pour obtenir une version du tronc de KDE tournant sur les systèmes Linux/BSD. Tout au long de ce tutoriel le shell bash est utilisé. Si vous souhaitez mettre en place KDE sur d'autres systèmes tels que Solaris, Mas OS ou Microsoft Windows, veuillez aller sur la page Build et jeter un oeil sur les liens en bas de page correspondant à votre système.

 

Warning
Attendez-vous à avoir beaucoup d'erreurs de compilation les lundis lorsque des modifications critiques sont implémentées. Le dashboard répertorie les plantages non souhaités. Vous etes encouragés à réparer les modules.

Prérequis

Les éléments suivants doivent être installés sur votre machine avant de pouvoir continuer ce tutoriel :

• gcc et g++ du projet gcc, de préférence en version 4.1 minimum
• svn le client du système de gestion de version subversion
• Les bibliothèques de développement et les fichiers d'en-tête de X11, OpenGL (mesa-common-dev and libglu1-mesa-dev), libjpeg, libpng, libungif, libclucene, librdf, libxml2 et libxslt
• Le script makeobj, qui fait partie du projet kdesdk. Vous pouvez l'installer avec kdesdk ou une partie de celui-ci (kdesdk-scripts sur une Debian) ou un paquetage similaire, ou encore le télécharger depuis WebSVN.
• Le paquetage shared-mime-info, le standard MIME du projet freedesktop que KDE utilise à présent
• boost est requis par kdebase; après la compilation et/ou l'installation de boost et dans le but d'informer cmake de son emplacement (FindBoost), ajoutez le répertoire de boost (celui contenant les sous-répertoire de fichiers include) à CMAKE_INCLUDE_PATH ou créez une variable d'environnement BOOST_ROOT que vous positionnerez sur le répertoire de boost.

Il est également nécessaire d'avoir le shell bash installé.

Kubuntu

Dans Kubuntu 7.04 (Fiesty) vous pouvez installer les dépendances dont vous avez besoin pour la construction avec la commande : sudo aptitude install build-essential cdbs debhelper cmake libungif4-dev \ libxml2-dev libxslt1-dev libbz2-dev libclucene-dev librdf-dev \ shared-mime-info libgl1-mesa-dev libglu1-mesa-dev mesa-common-dev \ libxext-dev libjpeg-dev libpng-dev libsm-dev libxinerama-dev \ libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev

Vous pouvez éviter l'installation manuelle de Qt 4.3, CMake 2.4.6 et DBus en installant les paquetages suivant (avec leurs dépendances): sudo aptitude install libqt4-dev-kdecopy libdbus-1-dev cmake

Pour un bon fonctionnement du framework apidox vous avez aussi besoin de : sudo aptitude install graphviz

openSUSE

Dans openSUSE, vous pouvez installez les paquetages manquant avec Zypper : sudo zypper install <package-name>

Sur d'anciennes versions de SuSE, vous pouvez utiliser YaST : yast2 -i <packagename>

La plupart des paquetages dont vous aurez besoin sont : xorg-x11-devel, libxml2-devel, kdesdk3, clucene-core-devel, libjpeg-devel, liblrdf-devel, libpng-devel, libxslt-devel, Mesa-devel, giflib-devel, subversion, gcc, gcc-c++

Les paquetages binaires de CMake pour openSUSE sont disponible depuis openSUSE build service.

Création d'un compte pour le développement de KDE4

 

Note

Certaines personnes aime avoir un compte utilisateur spécifique pour KDE4. Les instructions suivantes ont été écrites en ce sens. Cependant il est beaucoup plus efficace de tout faire avec un seul compte utilisateur. Voir "Les scripts pour accroire sa productivité dans KDE4" pour plus de détails. Vous pouvez toujours suivre les instructions suivantes mais ne placez pas les variables d'environnement dans le fichier .bashrc. Placez les dans un fichier séparés que vous sourcerez pour passer dans l'environnement de développement de KDE.

Option 1 : En ligne de commande

useradd -m kde-devel passwd kde-devel

Option 2 : Avec KControl

Au lieu d'utiliser la commande ci-dessus, vous pouvez aussi utiliser le module Utilisateur dans le centre de contrôle de KDE si KDE3 est déjà installé sur votre machine.

Mise en place de l'environnement

Copiez le fichier ~/.bashrc depuis votre compte utilisateur normal vers le nouveau compte kde-devel. Ensuite, copiez et collez le contenu du script d'exemple .bashrc dans ~kde-devel/.bashrc. Assurez vous de commenter la ligne alias make=makeobj si vous n'avez pas la commande makeobj disponible. Pour le faire démarrer, vous devez ouvrir un nouveau shell bash ou exécutez source ~/.bashrc

Cela vous donnera accès à des commandes tel que cmakekde qui sont utilisé dans ce tutoriel de même que la vérification des chemins corrects pour les binaires de Qt, KDE et CMake.

Pour plus d'information, veuillez lire le tutoriel Getting Started/Increased Productivity in KDE4 with Scripts.

Se logger avec le nouvel utilisateur

Changer pour l'utilisateur kde-devel : (n'oubliez pas le tiré) su - kde-devel

Le reste de ce tutoriel suppose que vous tournez avec l'utilisateur kde-devel.

Le shell du développeur

Sur certain système le shell par defaut pour les nouveaux utilisateurs est /bin/sh. Si ce n'est pas le cas pour votre système, vous pouvez sauter cette section. Utiliser /bin/sh peut poser beaucoup de problèmes et vous devriez le changer pour /bin/bash ou un autre shell.

Option 1 : En tant que l'utilisateur kde-devel

Si vous n'avez pas les privilèges root et que votre système vous permet le changement de votre shell pour l'application chsh, vous pouvez alors essayer de changer votre shell pour /bin/bash en utilisant la commande : chsh -s /bin/bash kde-devel

Option 2 : En tant qu'administrateur

Si votre système est fourni avec l'application usermod vous pouvez lancer la commande suivante en tant que root : usermod -s /bin/bash.

Une autre solution consiste à utiliser l'application vipw en tant que root pour éditer de manière sécurisée le fichier /etc/passwd. Localisez 'kde-devel' dans le fichier, remplacez '/bin/sh' à la fin de la ligne par '/bin/bash', sauvegardez vos modifications et quittez.

Le nouveau shell sera démarré automatiquement quand vous vous loggerez de nouveau en tant que kde-devel.

D-Bus

QtDBus and KDE are known to work with D-Bus versions 0.62, as well as 0.92 and upwards. Versions 0.60 and 0.61 may work too but are not tested. Versions 0.90 and 0.91 are known not to work. We recommend using post-1.0 release versions (at least 0.94), so consider upgrading if you haven't done so.

You may skip this section if you have a recent D-Bus version or if you don't want to upgrade.

Before running these steps in the recipe, make sure your X11 headers and libraries are available. The configure script run on line 5 should output:

Building X11 code:        yes

Procédure

 

Tip
Make sure you did set up your environment correctly as described above. This is necessary for the cs and cb functions to work.

cs # cs is not a typo
wget http://dbus.freedesktop.org/releases/dbus/dbus-1.0.2.tar.gz
tar -xvzf dbus-1.0.2.tar.gz
cd dbus-1.0.2/
./configure --prefix=$DBUSDIR --localstatedir=$KDEDIR/var
make
make install
dbus-uuidgen --ensure

Ce qu'il se passe

After changing into the source directory (line 1), D-Bus source code is downloaded from freedesktop.org (line 2) and unpacked (line 3). After going into the newly created D-Bus directory (line 4), the build is set up using the supplied configure script (line 5). After building (line 6) and installing (line 7) D-Bus, we use the dbus-uuidgen tool to install a machine identification file that allows the bus to start automatically when the desktop session starts (line 8).

Note that you need write access to /var for the last two steps. If your system does not have the sudo command, you can use the su command instead, e.g. su -c "make install".

En cas de difficultés

If you get the error makeobj: command not found you are lacking the command makeobj.

CMake

Skip this if you have CMake >=2.4.5 installed. You should be able to directly use the binary packages available on the CMake site. There are also distribution specific packages available.

Procédure

cs # cs is not a typo
wget http://www.cmake.org/files/v2.4/cmake-2.4.6.tar.gz
tar zxf cmake-2.4.6.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.4.6/bootstrap
make
sudo make install

Ce qu'il se passe

First, we go back to the kde-devel user's source directory (line 1), get the CMake sources (line 2) and unpack them (line 3). We create a directory to build CMake in (line 4) and go into it (line 5). We then run the CMake bootstrap script to set up the CMake build (line 6), then make (line 7) and install it (line 8) using the root user.

If your system does not have the sudo command, you can instead do su -c "make install".

Qt

Next we need to get the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. That is still an unreleased version, so your distribution probably doesn't have packages for it. You should use the copy in the KDE Subversion servers.

Procédure

cd
svn checkout svn://anonsvn.kde.org/home/kde/trunk/qt-copy
cd qt-copy
./apply_patches
./configure -qt-gif -no-exceptions -debug -fast \
 -prefix $QTDIR -qdbus -pch -nomake examples \
 -nomake demos
make sub-src sub-tools
# make install: only if QTDIR is not the current directory!
make install

Ce qu'il se passe

We switch back to the kde-devel user's home directory (line 1) and download the source code using subversion (svn) from KDE's repository (line 2). After changing into the resulting qt-copy directory (line 3), we run a script that manages the patches that come with qt-copy (line 4).

Once the patches have been applied, we then set up the build using the configure script (line 5-7). The various command line options used are explained in the qt-copy/README.qt-copy file. Finally, we build the minimal requirements for KDE (line 8) and install (line 9-10) Qt. If you want all the example and demo applications, you can either build them individually or simply do a make from the qt-copy directory.

Note that the installation does not require root as it installs Qt locally into $QTDIR. Anyway, installation is only needed if $QTDIR differs from $HOME/qt-copy, which is not the case if you have exactly followed the instructions.

En cas de difficultés

If you get "error: X11/Xlib.h: No such file or directory", install the devel package of xorg (the actual name may vary between operating systems, for example it is xorg-dev on Ubuntu based systems such as Kubuntu).

If you get an error in the configure step about missing defines, check the value of $QMAKESPEC. Some distributions set this to point directly to the system-installed Qt. If unset QMAKESPEC solves the problem, you probably want to add it to the ~/.bashrc script.

If you get an error ".pch/debug-shared/QtCore", this is because Qt-4.3 enables precompiled headers if your gcc supports it, but for some reason it doesn't work for you. If you use distcc, configure qt with -no-pch. If you use icecream, update to the latest icecream from svn trunk.

Try running any Qt program, like assistant. If it crashes in QSpanData::adjustSpanMethods, then your problem is the oxygen style. Try removing lib/kde4/plugins/styles/kstyle-oxygen.so and lib/kde4/plugins/styles/oxygen.so if they exist in the KDE install prefix.

Strigi

 

Warning
If you have jumped to this section without reading Setting Up The Environment, the recipes provided will not work. The recipes are not in error; cs and cb are not typos. Your environment needs to be set up correctly for these instructions to work for you.

The code for getting file metadata now relies on Strigi. To install Strigi you need the libraries and headers for libz, libbz2, openssl (libcrypto or libssl), libclucene (=0.9.16; version 0.9.17 does not work), and either libxml2 or libexpat.

Procédure

cs # cs is not a typo
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/strigi
cd strigi
cmakekde

Ce qu'il se passe

We change to the base source directory (line 1). We download the sources for Strigi using subversion (line 2), go into the new ~/src/strigi directory (line 3), and commence the build (line 4). This will leave us in the strigi build directory after the build is completed.

En cas de difficultés

If you get

CMake Error: This project requires some variables to be set,
and cmake can not find them.
Please set the following variables:
LIBXML2_INCLUDE_DIR (ADVANCED)

you should install the development package for libxml2.

Soprano

 

Warning
If you have jumped to this section without reading Setting Up The Environment, the recipes provided will not work. The recipes are not in error; cs and cb are not typos. Your environment needs to be set up correctly for these instructions to work for you.

The code for getting file kmetadata relies on Soprano. To install Soprano you need the libraries and headers for librdf.

Procédure

cd $KDE_SRC
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/soprano
cd soprano
cmakekde

Ce qu'il se passe

We change to the base source directory (line 1). We download the sources for Soprano using subversion (line 2), go into the new ~/src/soprano directory (line 3), and commence the build (line 4). This will leave us in the soprano build directory after the build is completed.

En cas de difficultés

If you get

CMake Error: Could NOT find REDLAND

then you need librdf from the Redland. If your distribution does not provide the librdf package, you can download the source there: http://download.librdf.org/source/ and build it.

kdelibs

With Qt4 and Strigi built, we can now move on to building KDE's base libraries. If you use the aforementioned .bashrc this is where those new functions come in handy.

Procédure

cd $KDE_SRC
mkdir KDE && cd KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd kdelibs
cmakekde

Ce qu'il se passe

We change to the base source directory (line 1) then make and go into the KDE directory (line 2). We download the sources for kdelibs using subversion (line 3), go into the new ~/src/KDE/kdelibs directory (line 4), and commence the build (line 5). This will leave us in the kdelibs build directory after the build is completed.

 

Tip
There might be missing dependencies on your system! They are easily overlooked in the output of cmakekde. You might want to do a cmake $KDE_SRC/KDE/MODULE_NAME prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)

Modules additionnels de CMake spécifiques à KDE

There are additional CMake modules in kdelibs/cmake/modules/ that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.

En cas de difficultés

If you have problems compiling kdelibs, first make sure the software in the Required Software section above is installed and works. Other possible hints include:

• If the cmakekde command fails stating that CMake requires an out of source build directory, remove ~/src/KDE/kdelibs/CMakeCache.txt, and try again.

If cmakekde still gives the same error then try this

cd
cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR \
-DCMAKE_BUILD_TYPE=debugfull \
-DKDE4_BUILD_TESTS=ON \
~/src/KDE/kdelibs
make
make install

• If you received an error stating "Please create a separate build directory and run 'cmake path_to_kdelibs [options]' there.", then you need to change to your build directory before running cmakekde. (e.g cs KDE/kdelibs && cb && cmakekde)
• If Qt wasn't found or the wrong version of Qt was found, make sure that the qmake from the Qt you need is the first qmake in the path.
• If the problems persist, try the CMake make-option --keep-going.
• Here you need the libungif library, otherwise you will get an error message like "Could NOT find GIF".
• Qt-4.3 upgrade: if you get a link error in kjsembed talking about QScriptEngine, edit CMakeCache.txt in kdelibs and remove the lines that talk about QT_QTUITOOLS_LIBRARY, then type make again (that static library has a new dependency, and the cmake code that adds it needs to run).
• if you get CMake Error: KDE Requires Qt to be built with SSL support

, install openssl-devel, and re-compile QT.

kdepimlibs

After kdelibs, but before kdebase, you need to build and install kdepimlibs.

Procédure

cs KDE # cs is not a typo
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
cd kdepimlibs
cmakekde

Ce qu'il se passe

We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new ~/src/KDE/kdepimlibs directory (line 3). We then commence the build (line 4). This will leave us in the kdepimlibs build directory after the build is completed.

kdebase

You may need kdebase for some kioslaves.

cs KDE # cs is not a typo
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
cd kdebase
cmakekde

En cas de problèmes

If you have troubles compiling kdebase:

• Make sure you have the libxss headers installed. (Usually you got undefined references on xscreensaver objects if you haven't those headers)
• which meinproc has to deliver /home/kde-devel/kde/bin/meinproc
• if cmakekde can not find the path of kdepimlibs, edit the file $KDE_BUILD/kdebase/CMakeCache.txt and manually set KDEPIMLIBS_INCLUDE_DIR:PATH=$KDE_BUILD/kdepimlibs
• if you get an error saying "Please set the following variables: X11_XTest_LIB (ADVANCED)", install the devel package of Xtst. On some systems, this is packaged separately from xext and called x11proto-xext-dev or libxtst-dev. You may also need to remove the CMakeCache.txt file in the build dir after installing the package.
• the same for "X11_Xinerama_LIB (ADVANCED)" where you will need the devel package for xinerama.
• if you get the error "Please set the following variables: FONTCONFIG_INCLUDE_DIR, FONTCONFIG_LIBRARIES (ADVANCED)", then you need to install the libfontconfig headers
• if you get the error "CMake Error: This project requires some variables to be set, and cmake can not find them. Please set the following variables: KMETADATA_LIBRARIES", you need to install soprano from kdesupport and to rebuild kdelibs

Générer localement la documentation de l'API

Although the API documentation for KDE is available online at api.kde.org, it is sometimes useful to have it on your own disk, for example when you want to use KDevelop for browsing the documentation or when you are not able to be online all the time.

Be aware that generating the API documentation can take several hours and takes almost half a gigabyte of diskspace. The generation is handled by a script in kdelibs/doc/api, you need doxygen to be able to run it.

To build the API documentation for kdelibs, type the following:

cs KDE # cs is not a typo
mkdir apidox
cd apidox
../kdelibs/doc/api/doxygen.sh ../kdelibs/

Félicitations !

You are now ready to start building other svn modules in the same fashion as you built kdebase, running and testing KDE4 or writing your own patches and applications.

See the Set up KDE 4 for development tutorial for how to start KDE 4 applications and how to use KDevelop to work on them.