Difference between revisions of "Getting Started/Build"

Jump to: navigation, search
(Configure Example)
Line 2: Line 2:
  
 
{{Template:I18n/Language Navigation Bar|Getting Started/Build}}
 
{{Template:I18n/Language Navigation Bar|Getting Started/Build}}
Here you will find instructions for compiling and installing KDE from source and suggestions for when compilation doesn't go so smoothly.
 
  
 
== Introduction ==
 
== Introduction ==
 +
This page provides an overview of the KDE build process.
  
 
== Extra Information ==
 
== Extra Information ==
  
The build process described in these pages is kept as simple and generic as possible, but it is generally assumed you are building KDE4 on Linux.  Extra information about building KDE under specific distributions, platforms or conditions can be found at the following links:
+
The build process described in these pages is kept as simple and generic as possible, but it is generally assumed you are building KDE4 on Linux.  Extra information about building KDE Software on specific distributions or platforms, or certain conditions can be found at the following links:
  
* [[/Historic|Building KDE3 or KDE2]]
 
 
* [[/Distributions|Linux, BSD and other *nix based distributions]]
 
* [[/Distributions|Linux, BSD and other *nix based distributions]]
 
* [[/Windows|Microsoft Windows]]
 
* [[/Windows|Microsoft Windows]]
 
* [[/Mac_OS_X|Apple Mac OS X]]
 
* [[/Mac_OS_X|Apple Mac OS X]]
 
* [[/KDE4/on_virtual_machines|On a Virtual Machine]].
 
* [[/KDE4/on_virtual_machines|On a Virtual Machine]].
 +
* [[/Historic|Building historic versions of KDE Software (KDE3 and KDE2)]]
  
== Build Basics ==
+
== Build Steps ==
This section will briefly explain the steps involved in building software so you understand the concepts so you are not being asked to blindly follow some recipes you do not understand.
+
This section will briefly explain the concepts and steps involved in building software so you are not being asked to blindly follow some recipes you do not understand.
  
 
It is assumed you are at least familiar with the basics of using the command line.
 
It is assumed you are at least familiar with the basics of using the command line.
  
=== Checkout ===
+
=== Source ===
The checkout step is obtaining a local copy of the source code that you want to build.  While you can download tarball snapshots of the code as at a given time or release to build, it is more common for doing development work to check a copy of the code out directly from the code repository.
+
The Source step is obtaining a local copy of the source code that you want to build.  There are 3 main ways of doing this:
 +
* Download a tarball snapshot of the code as at a given time or release.  This is most commonly done if you do not want to develop the code itself but just want to use it for a stable system installation, testing a release, or developing applications outside of the KDE SC.
 +
* Clone a copy of the project repository from Git
 +
* Checkout a copy of the project repository from Subversion
 +
 
 +
For developing on the unstable branch of the KDE SC it is recommended you Clone or Checkout the required repositories.
 +
 
 +
Note that Checkout has a different meaning in Git than it does in Subversion.
  
 
=== Configure ===
 
=== Configure ===
Line 30: Line 37:
 
=== Install ===
 
=== Install ===
  
=== Example Recipe ===
+
=== Update ===
 +
 
 +
== Build Example ==
 
The following example recipe shows the sequence of commands you would need to enter into the command line to build a typical KDE module:
 
The following example recipe shows the sequence of commands you would need to enter into the command line to build a typical KDE module:
  
Line 45: Line 54:
 
Let's break that recipe down and explain each step.
 
Let's break that recipe down and explain each step.
  
==== Checkout Example ====
+
==== Source Example ====
  
 
First you navigate to a convenient folder to save the code in:
 
First you navigate to a convenient folder to save the code in:
Line 94: Line 103:
 
* The third line tells CMake we also want the unit tests to be built.
 
* The third line tells CMake we also want the unit tests to be built.
 
* The fourth line tells CMake where to install the software.
 
* The fourth line tells CMake where to install the software.
 +
 +
=== Update Example ===
  
 
==== Build Example ====
 
==== Build Example ====
  
 
== Scripted Builds ==
 
== Scripted Builds ==
The easiest way to build the KDE SC from scratch is to use one of the build scripts that are available.  This approach is highly recommended for those new to building KDE SC as it takes care of the Checkout, Configure, Build, Install and Update steps for you.  The builds remain compatible with the manual methods of building KDE SC so you can change later if you want.
+
The easiest way to build the KDE SC from scratch is to use one of the build scripts that are available.  This approach is highly recommended for those new to building KDE SC as it takes care of the Source, Configure, Build, Install and Update steps for you.  The builds remain compatible with the manual methods of building KDE SC so you can change later if you want.
  
 
* The [[/kdesrc-build|kdesrc-bld]] script by Michael Pyne
 
* The [[/kdesrc-build|kdesrc-bld]] script by Michael Pyne
Line 113: Line 124:
 
== Building From Source ==
 
== Building From Source ==
  
 +
This section still to be updated, in the meantime you can obtain some needed steps from the following pages:
 
* [[Getting_Started/Build/KDE4|Download and Build KDE SC from Git]]
 
* [[Getting_Started/Build/KDE4|Download and Build KDE SC from Git]]
 
* [[Getting_Started/Build/KDE4.x|Build a stable 4.x release]]
 
* [[Getting_Started/Build/KDE4.x|Build a stable 4.x release]]

Revision as of 16:32, 5 March 2011

noframe
 
Warning
This page is yet to be reviewed for changes required by the migration to Git. Information and commands on this page may no longer be valid and should be used with care. Please see the KDE Git hub page for more details.



Contents

Getting Started/Build


Introduction

This page provides an overview of the KDE build process.

Extra Information

The build process described in these pages is kept as simple and generic as possible, but it is generally assumed you are building KDE4 on Linux. Extra information about building KDE Software on specific distributions or platforms, or certain conditions can be found at the following links:

Build Steps

This section will briefly explain the concepts and steps involved in building software so you are not being asked to blindly follow some recipes you do not understand.

It is assumed you are at least familiar with the basics of using the command line.

Source

The Source step is obtaining a local copy of the source code that you want to build. There are 3 main ways of doing this:

  • Download a tarball snapshot of the code as at a given time or release. This is most commonly done if you do not want to develop the code itself but just want to use it for a stable system installation, testing a release, or developing applications outside of the KDE SC.
  • Clone a copy of the project repository from Git
  • Checkout a copy of the project repository from Subversion

For developing on the unstable branch of the KDE SC it is recommended you Clone or Checkout the required repositories.

Note that Checkout has a different meaning in Git than it does in Subversion.

Configure

Build

Install

Update

Build Example

The following example recipe shows the sequence of commands you would need to enter into the command line to build a typical KDE module:

cd ~/kde-devel/src
git clone http://anongit.kde.org/kdelibs.git
mkdir ~/kde-devel/build/kdelibs
cd ~/kde-devel/build/kdelibs
cmake ~/kde-devel/src/kdelibs \
      -DCMAKE_BUILD_TYPE=debugfull \
      -DCMAKE_INSTALL_PREFIX=$KDEDIR
make
make install

Let's break that recipe down and explain each step.

Source Example

First you navigate to a convenient folder to save the code in:

cd ~/kde-devel/src

Then request a copy of the code from the KDE source repository, in this example a copy of kdelibs from Git:

git clone http://anongit.kde.org/kdelibs.git

This may take some time to process. For Git you will see out output similar to:

myuser@mybox:~/kde-devel/src> git clone http://anongit.kde.org/kdelibs.git
http://anongit.kde.org/kdelibs.git
Initialized empty Git repository in /home/myuser/kde-devel/src/kdelibs/.git/
remote: Counting objects: 722134, done.
remote: Compressing objects: 100% (138759/138759), done.
remote: Total 722134 (delta 586243), reused 715797 (delta 580373)
Receiving objects: 100% (722134/722134), 140.90 MiB | 706 KiB/s, done.
Resolving deltas: 100% (586243/586243), done.
myuser@mybox:~/kde-devel/src> 

This example will create a folder called ~/kde-devel/src/kdelibs containing all the kdelibs source code and all its history since KDE began.

For an SVN checkout you will instead see output similar to:

myuser@mybox:~/kde-devel/src> svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
A    kdesdk/cmake
A    kdesdk/cmake/samples
A    kdesdk/cmake/samples/kpager
A    kdesdk/cmake/samples/kpager/CMakeLists.txt
...
A    kdesdk/COPYING.LIB
U   kdesdk
Checked out revision 1223739.
myuser@mybox:~/kde-devel/src> 

Configure Example

First you create a convenient folder to build the code in:

mkdir ~/kde-devel/build/kdelibs
cd ~/kde-devel/build/kdelibs

Next you need to run CMake to create the configuration files to be used in the build:

cmake ~/kde-devel/src/kdelibs \
      -DCMAKE_BUILD_TYPE=debugfull \
      -DKDE4_BUILD_TESTS=TRUE \
      -DCMAKE_INSTALL_PREFIX=$KDEDIR

Various options can be passed to CMake to control how a project gets built, but these are the most common:

  • The first line tells CMake where it can find the source code that is to be built.
  • The second line tells CMake what type of build is required, in this example a debugfull build that will include useful information for when we are debugging any the software.
  • The third line tells CMake we also want the unit tests to be built.
  • The fourth line tells CMake where to install the software.

Update Example

Build Example

Scripted Builds

The easiest way to build the KDE SC from scratch is to use one of the build scripts that are available. This approach is highly recommended for those new to building KDE SC as it takes care of the Source, Configure, Build, Install and Update steps for you. The builds remain compatible with the manual methods of building KDE SC so you can change later if you want.

Getting Ready

Manually building KDE Software requires that you first set up the build environment and install the required development tools and libraries.

Building From Source

This section still to be updated, in the meantime you can obtain some needed steps from the following pages:

Troubleshooting The Build

Compile and Linking errors are frequent sources of discouragement. Make careful note of the first occurrence of an error in your build process. It could be as simple as a bad environment variable, an unexpected version of a library or missing prerequisite. Please read the instructions carefully.

Please review your logs and do searches for fixes. If you cannot find a solution, try the Troubleshooting page. If you still cannot resolve the problem then please ask for help on IRC or a Mailing List.


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal