Getting Started/Build: Difference between revisions
No edit summary |
|||
| Line 4: | Line 4: | ||
== Introduction == | == Introduction == | ||
This page provides an overview of the KDE build process. | This page provides an overview of the KDE build process. once you complete the steps dscribed here you will have a complete KDE development system customized to your needs. | ||
== | == Platform Specific 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: | 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 under certain conditions can be found at the following links: | ||
* [[/Distributions|Linux, BSD and other *nix based distributions]] | * [[/Distributions|Linux, BSD and other *nix based distributions]] | ||
| Line 17: | Line 17: | ||
== Build Steps == | == 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. | 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. | ||
| Line 24: | Line 25: | ||
=== Source === | === Source === | ||
The two main options here are to | The ''Source'' step is obtaining a local copy of the source code that you want to build. For a detailed explanation of where to obtain the source code and how KDE stores and organizes our source code please read the [[Getting_Started/Sources|KDE Sources section]]. | ||
The two main options here are to either download a snapshot tarball of the code, or to directly access the source code repository. For developing on the unstable branch of the KDE SC it is recommended you directly access the required repositories. | |||
=== Configure === | === Configure === | ||
The ''Configure'' step is setting up how the source code is to be built and installed. | |||
=== Build === | === Build === | ||
The ''Build'' step is compiling the source code and linking it to other libraries to create the new executables and libraries. | |||
=== Install === | === Install === | ||
The ''Install'' step is copy the new executables and libraries somewhere that they can be found and run from. | |||
=== Update === | === Update === | ||
The ''Update'' step is updating an existing build to use the latest version of the source code and then re-building and re-installing it. | |||
== 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 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 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. | ||
| Line 42: | Line 53: | ||
* The [http://michael-jansen.biz/build-tool build-tool] script by Michael Jansen | * The [http://michael-jansen.biz/build-tool build-tool] script by Michael Jansen | ||
== | == Build and Install == | ||
Manually building KDE Software requires that you first set up the build environment and install the required development tools and libraries. | |||
You need to complete each of the following steps to build and/or install a working KDE development system Manually building KDE Software requires that you first set up the build environment and install the required development tools and libraries. | |||
* Set up your [[/Environment|Build Environment]] | * Set up your [[/Environment|Build Environment]] | ||
| Line 50: | Line 62: | ||
* Install or build [[/KdeSupport|kdesupport]] | * Install or build [[/KdeSupport|kdesupport]] | ||
These steps are yet to be completed: | |||
* [[/KDE_Development_Platform|Build KDE Development Platform]] | * [[/KDE_Development_Platform|Build KDE Development Platform]] | ||
* [[/KDE_Workspace|Build KDE Workspace]] | * [[/KDE_Workspace|Build KDE Workspace]] | ||
| Line 75: | Line 84: | ||
== Troubleshooting The Build == | == 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. | 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. | ||
Revision as of 19:32, 7 March 2011
Getting Started/Build
Languages: عربي | Asturianu | Català | Česky | Kaszëbsczi | Dansk | Deutsch | English | Esperanto | Español | Eesti | فارسی | Suomi | Français | Galego | Italiano | 日本語 | 한국어 | Norwegian | Polski | Português Brasileiro | Română | Русский | Svenska | Slovenčina | Slovenščina | српски | Türkçe | Tiếng Việt | Українська | 简体中文 | 繁體中文
Introduction
This page provides an overview of the KDE build process. once you complete the steps dscribed here you will have a complete KDE development system customized to your needs.
Platform Specific 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 under certain conditions can be found at the following links:
- Linux, BSD and other *nix based distributions
- Microsoft Windows
- Apple Mac OS X
- On a Virtual Machine.
- Building historic versions of KDE Software (KDE3 and KDE2)
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.
Once you have read the summary you can see a worked example here.
Source
The Source step is obtaining a local copy of the source code that you want to build. For a detailed explanation of where to obtain the source code and how KDE stores and organizes our source code please read the KDE Sources section.
The two main options here are to either download a snapshot tarball of the code, or to directly access the source code repository. For developing on the unstable branch of the KDE SC it is recommended you directly access the required repositories.
Configure
The Configure step is setting up how the source code is to be built and installed.
Build
The Build step is compiling the source code and linking it to other libraries to create the new executables and libraries.
Install
The Install step is copy the new executables and libraries somewhere that they can be found and run from.
Update
The Update step is updating an existing build to use the latest version of the source code and then re-building and re-installing it.
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.
- The kdesrc-bld script by Michael Pyne
- The build-tool script by Michael Jansen
Build and Install
You need to complete each of the following steps to build and/or install a working KDE development system Manually building KDE Software requires that you first set up the build environment and install the required development tools and libraries.
- Set up your Build Environment
- Install the Build Requirements
- Install or build Qt
- Install or build kdesupport
These steps are yet to be completed:
Short version: Using exactly the same recipe and environment you used to build kdesupport build the core KDE modules from Git in the following order:
kdelibs kdepimlibs kde-runtime kde-workspace kde-baseapps konsole kate
After this you are able to build whatever module you are interested in from the appropriate Git or Subversion repository.
The old instructions can be found here:
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.