Getting Started/Build: Difference between revisions

    From KDE TechBase
    No edit summary
    (working example does not work)
    (71 intermediate revisions by 12 users not shown)
    Line 1: Line 1:
    {{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|These pages are currently being completely re-written to reflect the new KDE infrastructure and may not be in a consistent state.  Information and commands on some page may no longer be valid and should be used with care.}}


    {{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.


    * [[Getting_Started/Using Project Neon to contribute to KDE|Using Project Neon to contribute to KDE]]
    * [[Getting_Started/EasyStartDevelopmentOnDebian | Build, change and run packaged KDE applications on Debian]]


    == Other Platforms ==
    == Introduction ==
    KDE can also be built on platforms other than Linux.  For more details please see the relevant page:


    * [[../FreeBSD|FreeBSD]
    This page provides an overview of the KDE build process. Once you complete the steps described here you will have a complete KDE development system customized to your needs.
    * [[../Windows|Microsoft Windows]
    * [[../Mac_OS_X|Apple Mac OS X]


    ==Build Notes for Special Users==
    == Build Steps ==


    * '''Distribution managers''' may be interested in [[Getting_Started/Build/KDE4/on_virtual_machines|installing KDE SC using a virtual machine]].
    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.
    * '''Core developers''' may want to use a [[Developer_Setups|common KDE developer setup]] (this page is not complete).


    == Build Environment ==
    It is assumed you are at least familiar with the basics of using the command line.
    The KDE Build System requires certain environment settings before it can build KDE software.  There are also further shortcut settings you can configure to make your like easier.  You can find the details of these on the [[../Environment|Build Environment] page.


    ==Qt==
    Once you have read the summary you can see a [[Getting_Started/Build/KDE4/on_virtual_machines|working example on a virtual machine here]].


    ''In each installation scenario above, Qt is installed in the most appropriate way.'' For your reference, there are three ways to install it:
    === Source ===


    ; KDE-Qt '''(Recommended)'''
    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]].
    :Previously known as qt-copy -- This is the minimum version of Qt any of your users are expected to have. It is also the recommended one. Some bugs may be fixed in new Qt, so you may have to work-around bugs in lower versions, including this one. However, it's generally considered more stable, since we manually sync releases from Main Qt, as well as our own patches which also fix bugs not already fixed in Main Qt.


    ; System Qt
    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.
    : Often the easiest way to go, because most people have it already, you may have to install the QCA plugin as root though. However, depending on how up-to-date your distribution is (most aren't) and if you are running KDE from master, then your Qt will probably be far too old.


    ; Main Qt
    === Configure ===
    : Get it straight from Nokia, experience the latest cool features and bugfixes (and regressions!). Bear in mind though, that applications which reside in master can only depend on a certain "highest" Qt version. This is because distributions either lag behind, or it is at an awkward time in the KDE Release Schedule, which could end up granting us a loss in stability. Other applications, like KDevelop, Amarok, and applications in playground, etc. have their own rules.


    The ''Configure'' step is setting up how the source code is to be built and installed.


    == Building The Source ==
    === Build ===


    ; KDE 4 (Development version, trunk)
    The ''Build'' step is compiling the source code and linking it to other libraries to create the new executables and libraries.
    :Instructions for installing the latest and greatest KDE development source code on:
    * [[/KDE4|Linux]]
    ** [http://en.opensuse.org/KDE/Developing/Guide openSUSE Linux]


    === Install ===


    ; [[/Older KDE Versions|Old Versions]]: Instructions for building older KDE versions.
    The ''Install'' step is copy the new executables and libraries somewhere that they can be found and run from.


    ; [[/Coexisting Versions|Coexisting Versions]]: Directions to build multiple KDE versions on the same machine simultaneously.
    === Update ===


    ; [[/FAQ|FAQ]]: Help with errors and other questions you might have.
    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.


    == Troubleshooting the build ==
    == Scripted Builds ==
    See [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]]


    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.
    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.


    Please review your logs and do searches for fixes. If you cannot find a solution, try [[Build/KDE4/Errors]], the IRC channel, and the mailing lists. You can post your detailed issue from [[Build/Stories]].
    Even KDE Core Developers use build scripts like these as opposed to doing everything manually, as there's just no point otherwise.
     
    If you run into any issues, be sure to ask either on the kde-devel mailing list, or the #kde-devel IRC channel (which many developers reside in and are willing to ask any questions or address any problems encountered).
     
    === kdesrc-build ===
    [[/kdesrc-build|kdesrc-build]] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories.
     
    === build-tool ===
    The [http://michael-jansen.biz/build-tool build-tool] is a ruby program script which is meant not for just building KDE, but also can easily be expanded to compile any other applications. It also has some neat features like progress bars and eta for compile time. It can also automatically generate a ~/.xsessionrc which can be used by KDM when you select to boot into a "Custom" session type. That will enable you to easily get into a KDE session which was built from source, without even having to modify any of your scripts like ~/.bashrc, ~/.zshrc, etc.
     
    Install rubygems through your package manager. Run <tt>sudo gem install build-tool</tt>. Now that build-tool is installed, we need to install the KDE recipes to have it build KDE from source. Run <tt>build-tool recipe add git://gitorious.org/build-tool/kde-trunk-recipe.git kde</tt> to add the KDE recipe to the program. Then <tt>build-tool recipes install kde</tt>. From there, you can run <tt>kde-build help</tt> to see the commands available for the KDE recipe, as well as compile and update the git repositories.
     
    For more detailed information, visit: http://michael-jansen.biz/build-tool
     
    == 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:
     
    * [[/Distributions|Linux, BSD and other *nix based distributions]]
    * [[/Windows|Microsoft Windows]]
    * [[/Mac_OS_X|Apple Mac OS X]]
    * [[/KDE4/on_virtual_machines|On a Virtual Machine]].
    * [[/Historic|Building historic versions of KDE Software (KDE3 and KDE2)]]
     
    == Stable versus Unstable ==
     
    A stable build is a released and supported version of KDE Software, such as KDE SC 4.6.  This software is guaranteed to remain unchanged other than bug-fixes.  You will want a Stable build if you want to use the KDE Software for normal use or to develop bug fixes.
     
    An unstable build is the latest development version of KDE Software and is not guaranteed to build or run properly at any given time.  You will want an Unstable build if you want to develop new features for KDE Software.
     
    In Git, the Unstable branch is called Master while in Subversion it is called Trunk.
     
    == 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.
     
    * Choose the appropriate [[/Methods|Build Method]] for your requirements
    * Set up your [[/Environment|Build Environment]]
    * Choose the appropriate [[/Recipes|Build Recipes]] for your requirements and environment
    * Install the [[/Requirements|Build Requirements]]
    * Install or build [[/Qt|Qt]]
    * Install or build [[/KDE_Support|KDE Support]]
    * Install or build [[/KDE_Development_Platform|KDE Development Platform]]
    * Install or build [[/KDE_Workspace|KDE Workspace]]
    * [[/KDE_Applications|Build KDE Applications]]
     
    == 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|Troubleshooting]] page.  If you still cannot resolve the problem then please [[Development/Getting_Help|ask for help]] on IRC or a Mailing List.
     
    == Starting KDE ==
     
    Having built and installed KDE, you will probably want to start it. Launching a full session requires some preparations, depending on whether you want to run the self-compiled KDE within another desktop environment or as a full-blow session:
     
    * [[Getting_Started/Run/Nested_Session|How to Run a nested session of KDE]]
    * [[Getting_Started/Run/Full_Session|How to Run a full session of KDE]]


    [[Category:Build KDE]]
    [[Category:Build KDE]]

    Revision as of 19:21, 26 January 2013

    Warning
    These pages are currently being completely re-written to reflect the new KDE infrastructure and may not be in a consistent state. Information and commands on some page may no longer be valid and should be used with care.



    Introduction

    This page provides an overview of the KDE build process. Once you complete the steps described here you will have a complete KDE development system customized to your needs.

    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 working example on a virtual machine 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.

    Even KDE Core Developers use build scripts like these as opposed to doing everything manually, as there's just no point otherwise.

    If you run into any issues, be sure to ask either on the kde-devel mailing list, or the #kde-devel IRC channel (which many developers reside in and are willing to ask any questions or address any problems encountered).

    kdesrc-build

    kdesrc-build (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories.

    build-tool

    The build-tool is a ruby program script which is meant not for just building KDE, but also can easily be expanded to compile any other applications. It also has some neat features like progress bars and eta for compile time. It can also automatically generate a ~/.xsessionrc which can be used by KDM when you select to boot into a "Custom" session type. That will enable you to easily get into a KDE session which was built from source, without even having to modify any of your scripts like ~/.bashrc, ~/.zshrc, etc.

    Install rubygems through your package manager. Run sudo gem install build-tool. Now that build-tool is installed, we need to install the KDE recipes to have it build KDE from source. Run build-tool recipe add git://gitorious.org/build-tool/kde-trunk-recipe.git kde to add the KDE recipe to the program. Then build-tool recipes install kde. From there, you can run kde-build help to see the commands available for the KDE recipe, as well as compile and update the git repositories.

    For more detailed information, visit: http://michael-jansen.biz/build-tool

    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:

    Stable versus Unstable

    A stable build is a released and supported version of KDE Software, such as KDE SC 4.6. This software is guaranteed to remain unchanged other than bug-fixes. You will want a Stable build if you want to use the KDE Software for normal use or to develop bug fixes.

    An unstable build is the latest development version of KDE Software and is not guaranteed to build or run properly at any given time. You will want an Unstable build if you want to develop new features for KDE Software.

    In Git, the Unstable branch is called Master while in Subversion it is called Trunk.

    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.

    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.

    Starting KDE

    Having built and installed KDE, you will probably want to start it. Launching a full session requires some preparations, depending on whether you want to run the self-compiled KDE within another desktop environment or as a full-blow session: