Archive:Getting Started/Build/Requirements: Difference between revisions

From KDE TechBase
m (Reverted edits by KennethMartinez (talk) to last revision by AnneW)
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOINDEX__
{{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 [[Development/Git|KDE Git hub page]] for more details. }}
{{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 [[Development/Git|KDE Git hub page]] for more details. }}


{{Template:I18n/Language Navigation Bar|Getting_Started/Build/Requirements}}
 


{{TutorialBrowser|
{{TutorialBrowser|
Line 19: Line 20:
This page details the software requirements that need to be installed on your system before you can start building KDE Software.  For most of these requirements it is preferable to use your distribution supplied packages, however in some case you will need to build some requirements yourself and this page will also explain how to do so.
This page details the software requirements that need to be installed on your system before you can start building KDE Software.  For most of these requirements it is preferable to use your distribution supplied packages, however in some case you will need to build some requirements yourself and this page will also explain how to do so.


=== Build Environment ===
=== Required Steps ===
 
You need to have completed the following steps:
* Set up your [[../Environment|Build Environment]]
* Selected your [[../Recipes|Build Recipes]]


Please see the [[../Environment|Build Environment]] page for the standard environment required.
== Definitions ==


=== Build Recipes ===
The Build Requirements for each Module will be documented in a common table format as follows:


Please see the [[../Recipes|Build Recipes]] page for the standard recipes required.
{| border="1" cellpadding="5" cellspacing="0"
|+ '''Build Requirements'''
|-
! width="20%" style="background-color:#EFEFEF;" | Requirement
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
! width="40%" style="background-color:#EFEFEF;" | Details
|-
| [http://en.wikipedia.org/wiki/Foobar Foobar]
| style="background-color:#FF6666" | >= 2.0
| style="background-color:#66FF66" | >= 1.0
| Yes
| A library to enable KDE Software to foo your bar.
|}


== Definitions ==
The fields in this table are defined as follows:


{| border="1" cellpadding="5" cellspacing="0"
{| border="1" cellpadding="5" cellspacing="0"
|-
|-
| width="25%" | '''Requirement'''
| width="30%" style="background-color:#EFEFEF;" | '''Requirement'''
| width="75%" | The project that KDE Software depends on, including a link to the Project home page.]
| width="70%" | The project that KDE Software depends on, including a link to the Project home page.]
|-
|-
| '''Stable Requires'''
| style="background-color:#EFEFEF;" | '''Stable Requires'''
| The version of the Project that the current Stable KDE Release requires.  The background color indicates if the requirement is optional (blue) or mandatory (red).  Stable is currently KDE Release 4.6.
| The version of the Project that the current Stable KDE Release requires.  The background color indicates if the requirement is optional (green) or mandatory (red).  Stable is currently KDE Release 4.6.
|-
|-
| '''Unstable Requires'''
| style="background-color:#EFEFEF;" | '''Unstable Requires'''
| The version of the Project that the current Unstable development version requires.  The background color indicates if the requirement is optional (blue) or mandatory (red).  Unstable is currently targeting KDE Release 4.7.
| The version of the Project that the current Unstable development version requires.  The background color indicates if the requirement is optional (green) or mandatory (red).  Unstable is currently targeting KDE Release 4.7.
|-
|-
| '''DevelPkgs?'''
| style="background-color:#EFEFEF;" | '''Devel Pkgs?'''
| If installing from distribution packages, whether you also need to install the -devel packages.
| If installing from distribution packages, whether you also need to install the -devel packages.
|-
|-
| '''Details'''
| style="background-color:#EFEFEF;" | '''Details'''
| More information about the Project and the requirement
| More information about the Project and the requirement
|}
|}
Line 58: Line 77:
|+ '''KDE Software Build Requirements'''
|+ '''KDE Software Build Requirements'''
|-
|-
! width="20%" | Requirement
! width="20%" style="background-color:#EFEFEF;" | Requirement
! width="15%" | Stable Requires
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
! width="15%" | Unstable Requires
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
! width="10%" | Devel Pkgs?
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
! width="40%" | Details
! width="40%" style="background-color:#EFEFEF;" | Details
|-
|-
| GCC / G++
| GCC / G++
| >= 4.2
| style="background-color:#FF6666" | >= 4.2
| >= 4.2
| style="background-color:#FF6666" | >= 4.2
| No
| No
|
|
|-
|-
| Git
| [http://git-scm.com/ Git]
|  
| style="background-color:#66FF66" |
|  
| style="background-color:#66FF66" |
| No
| No
|  
| Revision control software, required for development builds.
|-
|-
| SVN
| [http://subversion.apache.org/ Subversion]
|  
| style="background-color:#66FF66" |
|  
| style="background-color:#66FF66" |
| No
| No
|  
| Revision control software, required for development builds.
|-
|-
| [http://pkg-config.freedesktop.org/wiki/ pkg-config]
| [http://pkg-config.freedesktop.org/wiki/ pkg-config]
Line 89: Line 108:
|-
|-
| [http://cmake.org/HTML/index.html CMake]
| [http://cmake.org/HTML/index.html CMake]
| >= 2.6.4
| style="background-color:#FF6666" | >= 2.6.4
| >= 2.6.4
| style="background-color:#FF6666" | >= 2.6.4
| No
| No
|  
| Build configuration tool
|-
|-
| [http://www.freedesktop.org/wiki/Software/dbus DBus]
| [http://www.freedesktop.org/wiki/Software/dbus DBus]
| >= 1.4.0
| style="background-color:#FF6666" | >= 1.4.0
| >= 1.4.0
| style="background-color:#FF6666" | >= 1.4.0
| Yes
| Yes
| Also dbus-glib
| Also dbus-glib
Line 170: Line 189:
| >=  
| >=  
| Yes
| Yes
|
|-
| [http://sourceforge.net/projects/oscaf/files/ Shared-Desktop-Ontologies]
| >=
| >=
| No
|  
|  
|-
|-
Line 195: Line 220:


== Shared-Desktop-Ontologies ==
== Shared-Desktop-Ontologies ==
Requirements as at 2011-03-02, Stable Branch currently KDE Release 4.6, Master currently targeting KDE Release 4.7.


{| border="1" cellpadding="5" cellspacing="0" align="center"
The Ontologies are a shared resource required for the semantic desktop.
 
{| border="1" cellpadding="5" cellspacing="0"
|+ '''KDE Software Build Requirements'''
|-
|-
! Requirement
! width="20%" style="background-color:#EFEFEF;" | Requirement
! Stable
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
! Master
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
! Devel?
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
! Details
! width="40%" style="background-color:#EFEFEF;" | Details
|-
|-
| [http://sourceforge.net/projects/oscaf/files/ Shared-Desktop-Ontologies]
| [http://sourceforge.net/projects/oscaf/ Shared-Desktop-Ontologies]
| >=
| >=
| >=
| >= 0.7
| No
| No
|  
|  
|}
|}


The ontologies are a shared resource required for the semantic desktop.  Your distribution packages should be sufficient for this package but some older distributions may not have them.
Your distribution packages should be sufficient for this package but some older distributions may not have them so you may need to build them yourself using either the Easy Recipe or Full Recipe.
 
=== Easy Recipe ===
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
 
cd <your source root directory>
svn checkout https://oscaf.svn.sourceforge.net/svnroot/oscaf/trunk/ontologies
cd ontologies
cmakekde


=== Full Recipe ===
To obtain the source you can either download a tarball from the website or use the following git command:
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.


  cd <your source root directory>
  git clone git://oscaf.git.sourceforge.net/gitroot/oscaf/shared-desktop-ontologies
svn checkout https://oscaf.svn.sourceforge.net/svnroot/oscaf/trunk/ontologies
cd <your build root directory, or the module source dir>
mkdir <your module build dir>
cd <your module build dir>
cmake <path to your module source dir>
      \ -DCMAKE_INSTALL_PREFIX=$KDEDIR
      \ -DCMAKE_BUILD_TYPE=debugfull
nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
make install


== Next Step ==
== Next Step ==
Once all requirements have been installed it is time to install [[Getting_Started/Build/Qt|Qt]]
Once all requirements have been installed it is time to install [[Getting_Started/Build/Qt|Qt]]

Latest revision as of 15:53, 31 July 2012

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.



Building KDE4 From Source/Requirements
Tutorial Series   Getting Started
Previous   Getting Started
What's Next   Qt
Further Reading   n/a

Introduction

This page details the software requirements that need to be installed on your system before you can start building KDE Software. For most of these requirements it is preferable to use your distribution supplied packages, however in some case you will need to build some requirements yourself and this page will also explain how to do so.

Required Steps

You need to have completed the following steps:

  • Set up your [[../Environment|Build Environment]]
  • Selected your [[../Recipes|Build Recipes]]

Definitions

The Build Requirements for each Module will be documented in a common table format as follows:

Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Foobar >= 2.0 >= 1.0 Yes A library to enable KDE Software to foo your bar.

The fields in this table are defined as follows:

Requirement The project that KDE Software depends on, including a link to the Project home page.]
Stable Requires The version of the Project that the current Stable KDE Release requires. The background color indicates if the requirement is optional (green) or mandatory (red). Stable is currently KDE Release 4.6.
Unstable Requires The version of the Project that the current Unstable development version requires. The background color indicates if the requirement is optional (green) or mandatory (red). Unstable is currently targeting KDE Release 4.7.
Devel Pkgs? If installing from distribution packages, whether you also need to install the -devel packages.
Details More information about the Project and the requirement

System Prerequisites

TODO: Complete updating this list

All of these packages should be installed from your distribution. If you cannot meet these requirements from your distribution, it is recommended to either update to a more recent distribution or to build KDE in a virtual machine.

Requirements as at 2011-03-02.

KDE Software Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
GCC / G++ >= 4.2 >= 4.2 No
Git No Revision control software, required for development builds.
Subversion No Revision control software, required for development builds.
pkg-config >= >= No
CMake >= 2.6.4 >= 2.6.4 No Build configuration tool
DBus >= 1.4.0 >= 1.4.0 Yes Also dbus-glib
X11 >= >= Yes
Mesa >= >= Yes mesa-common-dev and libglu1-mesa-dev
libjpeg >= >= Yes
libpng >= >= Yes
libungif >= >= Yes
librdf >= >= Yes
libbz2 >= >= Yes
libxml2 >= >= Yes
libxslt >= >= Yes
Boost >= >= Yes
libmysqlclient >= >= Yes
shared-mime-info >= >= Yes
Shared-Desktop-Ontologies >= >= No
DocBook XML DTD's >= 4.2 >= 4.2 No Required for the KDE documentation and help
DocBook XSl Stylesheets >= 4.2 >= 4.2 No Required for the KDE documentation and help

Hardware Libraries

HAL (Hardware Abstraction Layer) is required by KDE 4.5 and earlier for interfacing with your hardware. Your distribution supplied packages should be sufficient for this.

From KDE 4.6 onwards HAL has been deprecated in favor of uDisk, uPower and related projects, but all but the most recent distributions will still require HAL.

Distributions

Many distributions provide shortcut meta-packages or install commands to simplify installing all the KDE requirements. Check the Distributions page first to see if your distribution provides a simple way to install the requirements.

Shared-Desktop-Ontologies

The Ontologies are a shared resource required for the semantic desktop.

KDE Software Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Shared-Desktop-Ontologies >= >= 0.7 No

Your distribution packages should be sufficient for this package but some older distributions may not have them so you may need to build them yourself using either the Easy Recipe or Full Recipe.

To obtain the source you can either download a tarball from the website or use the following git command: 

git clone git://oscaf.git.sourceforge.net/gitroot/oscaf/shared-desktop-ontologies

Next Step

Once all requirements have been installed it is time to install Qt

Retrieved from "https://techbase.kde.org/index.php?title=Archive:Getting_Started/Build/Requirements&oldid=74121"