|
|
| (104 intermediate revisions by 30 users not shown) |
| Line 1: |
Line 1: |
| {{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4}}
| | #REDIRECT [[Getting_Started/Build|Building KDE]] |
| | |
| {{TutorialBrowser|
| |
| | |
| series=Getting Started|
| |
| | |
| name=Building KDE4 From Source|
| |
| | |
| pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|
| |
| | |
| next=[[../../Set_up_KDE_4_for_development|Set up KDE 4 for development]]|
| |
| | |
| reading=[[../kdesvn-build|kdesvn-build: The KDE From Subversion Build Tool]]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]<br>[[../KDE4/Windows|Instructions for MS Windows]]|
| |
| }}
| |
| | |
| == Abstract ==
| |
| | |
| This tutorial shows one way to get KDE from trunk running on Linux/BSD systems. There are also tutorials for [[Getting_Started/Build/KDE4/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[Getting_Started/Build/KDE4/Mac OS X|Mac OS X]] and [http://solaris.kde.org/ Solaris]. Throughout the tutorial the bash shell is used.
| |
| | |
| {{warning|Expect a higher risk of build failure '''on Mondays''' when most kdelibs changes are committed. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.}}
| |
| | |
| == Create a user account for KDE4 development ==
| |
| | |
| {{Note|
| |
| Some people like to have a separate user account for KDE 4 (for instance an old bug deleted files by mistake), and the instructions below were written with that approach.
| |
| | |
| However it is much more efficient to do everything with a single user account, see [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]
| |
| for more details.
| |
| | |
| You can still follow the instructions below, but don't put the environment variables in your <tt>.bashrc</tt>, put them in a separate file that you source to switch to the KDE 4 environment.
| |
| }}
| |
| | |
| | |
| === Option 1: Command Line ===
| |
| {{Note|
| |
| On some systems a new user is configured by default to use {{path|/bin/sh}}. Using {{path|/bin/sh}} can be very inconvenient to work with and you may want to change it to {{path|/bin/bash}} or another shell.
| |
| On Ark Linux and Fedora, you can skip the <tt>-s /bin/bash</tt> switch - {{path|/bin/sh}} is {{path|bash}}.
| |
| }}
| |
| <code bash>
| |
| useradd -m kde-devel -s /bin/bash
| |
| passwd kde-devel
| |
| </code>
| |
| | |
| | |
| {{Warning|
| |
| The new kde-devel user will not be added automatically to all the user groups, which will result in not having sound, not being able to sudo, etc. Edit your /etc/groups file to add the kde-devel user to all the groups that you need (probably the groups that your usual username is already assigned to).
| |
| }}
| |
| | |
| === Option 2: Using KControl ===
| |
| | |
| Instead of using the commands above, you can also use the User module in the KDE Control Center if you already have KDE3 installed.
| |
| | |
| === Setting up the environment ===
| |
| | |
| Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account. Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>[[Getting Started/Build/KDE4#Required Software|makeobj]]</tt> command available. Alternatively, you can download the kde-sdk package (or perform a subversion checkout) and include the kde-sdk/scripts/ directory in your path. You will probably also want to modify the path to make sure it doesn't include your kde3 paths. Also if you want to use KDevelop to develop KDE 4 applications you may pass the ''-GKDevelop3'' flag to the ''cmake'' command (to make CMake generate KDevelop project files, it will help to avoid rebuilding in the future, see [[Getting_Started/Set_up_KDE_4_for_development#Setting_up_the_environment|this]]).
| |
| To make it run, you have to open a new bash or to execute
| |
| <code bash>
| |
| source ~/.bashrc
| |
| </code>
| |
| | |
| This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.
| |
| | |
| For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.
| |
| | |
| === Switching to the New User ===
| |
| Switch to the user kde-devel: (don't forget the dash)
| |
| <code bash>
| |
| ssh -X kde-devel@localhost
| |
| </code>
| |
| | |
| {{Note|
| |
| If the ssh command fails, check out the [[Getting_Started/Set_up_KDE_4_for_development#Launching_KDE_4_apps|Launching KDE 4 apps]] section of the [[Getting_Started/Set_up_KDE_4_for_development|KDE4 development guide]].
| |
| }}
| |
| | |
| == Required packages from your distribution ==
| |
| The requirements to build kde4 from source vary from distribution to distribution. Instructions for your distribution are provided below:
| |
| | |
| * [[Getting_Started/Build/KDE4/Ark Linux|Ark Linux]]
| |
| * [[Getting_Started/Build/KDE4/Arch Linux|Arch Linux]]
| |
| * [[Getting_Started/Build/KDE4/Fedora|Fedora]]
| |
| * [[Getting_Started/Build/KDE4/Kubuntu and Debian|Kubuntu and Debian]]
| |
| * [[Getting_Started/Build/KDE4/openSUSE|openSUSE]]
| |
| * [[Getting_Started/Build/KDE4/Gentoo|Gentoo]]
| |
| * [[Getting_Started/Build/KDE4/Mandriva|Mandriva]]
| |
| | |
| Your next compilation step depends on the packages supplied by your distro.
| |
| | |
| === Compiling qt-copy, HAL etc. ===
| |
| If you do not want to use the packages provided by your distro you can compile things like Qt yourself. Instructions for building all dependencies including HAL, Cmake, Qt4 (qt-copy) and kde-support are available in [[Getting_Started/Build/KDE4/Prerequisites|the build prerequisites page]].
| |
| | |
| == Building KDE for development or stable use ==
| |
| | |
| The commands below are used to build the latest unstable version of KDE from trunk. This should not be used in a production environment, but is recommended for developers.
| |
| | |
| To build the stable version of KDE4, change the svn checkout commands below to <tt>branches/KDE/4.0/</tt> instead of <tt>trunk/KDE/</tt>, ie:
| |
| | |
| svn checkout svn://anonsvn.kde.org/home/kde/branches/KDE/4.0/kdelibs
| |
| | |
| svn checkout svn://anonsvn.kde.org/home/kde/branches/KDE/4.0/kdepimlibs
| |
| | |
| svn checkout svn://anonsvn.kde.org/home/kde/branches/KDE/4.0/kdebase
| |
| | |
| etc...
| |
| | |
| == kdelibs ==
| |
| | |
| We can now move on to building KDE's base libraries.
| |
| | |
| === The Recipe ===
| |
| cd
| |
| cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
| |
| mkdir KDE && cd KDE
| |
| svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
| |
| cd kdelibs
| |
| cmakekde
| |
| | |
| === What's Happening ===
| |
| 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 {{path|~/kde/src/KDE/kdelibs}} directory (line 4), and commence the build (line 5). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.
| |
| | |
| {{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
| |
| You might want to do a <tt>cmake $KDE_SRC/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}
| |
| | |
| === Additional KDE-specific CMake know-how ===
| |
| | |
| There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.
| |
| | |
| To make a non-debug-release (e.g. suppressing all kDebug() messages), use e.g.
| |
| cmake -DCMAKE_BUILD_TYPE=Release . && make && make install
| |
| | |
| === Troubleshooting ===
| |
| | |
| For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdelibs|kdelibs troubleshooting section]].
| |
| | |
| == kdepimlibs ==
| |
| After <tt>kdelibs</tt>, but before ''kdebase'', you need to build and install ''kdepimlibs''.
| |
| | |
| === The Recipe ===
| |
| <!--'cs' and 'cb' are NOT typos!-->
| |
| cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
| |
| svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
| |
| cd kdepimlibs
| |
| cmakekde
| |
| | |
| === What's Happening ===
| |
| 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 {{path|~/kde/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.
| |
| | |
| === Troubleshooting ===
| |
| | |
| For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdepimlibs|kdepimlibs troubleshooting section]].
| |
| | |
| == kdebase ==
| |
| kdebase is divided into three parts:
| |
| * '''apps'''
| |
| :This contains applications like Dolphin or KWrite.
| |
| * '''runtime'''
| |
| :This contains things needed by every application at runtime, like icons. It is a required dependency for each KDE application, so you have to compile and install this.
| |
| * '''workspace'''
| |
| :This contains things specific to the KDE desktop, like Plasma or the window manager. Most stuff here depends on X11. You only need it if you want to build a full KDE desktop.
| |
| | |
| You can build all of kdebase at once, which is described in the recipe below. If you only want to build kdebase-runtime, which is the only requirement, you can replace <code bash>cd kdebase</code> with <code bash>cd kdebase/runtime</code> in the recipe below.
| |
| | |
| === The Recipe ===
| |
| <!--'cs' and 'cb' are NOT typos!-->
| |
| cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
| |
| svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
| |
| cd kdebase
| |
| cmakekde
| |
| | |
| === Troubleshooting ===
| |
| For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdebase|kdebase troubleshooting section]].
| |
| | |
| == Running KDE 4 programs ==
| |
| | |
| You can now run KDE 4 programs (e.g. kwrite) by typing:
| |
| ssh -X kde-devel@localhost
| |
| kwrite
| |
| | |
| === Troubleshooting ===
| |
| | |
| For troubleshooting issues see [[Getting_Started/Build/KDE4/Troubleshooting#Running_programs|troubleshooting running programs]].
| |
| | |
| == Generating local API documentation ==
| |
| Although the API documentation for KDE is available online at [http://api.kde.org api.kde.org], it is sometimes useful to have it on your own disk, for example when you want to use [[Getting_Started/Set_up_KDE_4_for_development#KDevelop|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 {{path|kdelibs/doc/api}}, you need <tt>doxygen</tt> to be able to run it.
| |
| | |
| To build the API documentation for kdelibs, type the following:
| |
| <!--'cs' and 'cb' are NOT typos!-->
| |
| cs KDE/kdelibs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
| |
| $KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
| |
| --doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .
| |
| | |
| You will notice a new subdirectory called {{path|kdelibs-apidocs}} is created for you. Simply copy that directory to whereever you want your API documentation to be stored.
| |
| | |
| Repeat for other modules (eg. kdepimlibs, kdevplatform, etc) as desired. For example:
| |
| cs KDE/kdepimlibs
| |
| $KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
| |
| --doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .
| |
| | |
| Another, even easier method involves downloading this [[Doxyfile]] to your local system. Then simply change directory to where you want to create the documentation and run
| |
| <code bash>
| |
| % doxygen /path/to/Doxyfile
| |
| </code>
| |
| Then review the file {{path|doxygen.log}} to see the doxygen errors and warnings. You'll find the actual documentation in the {{path|apidocs}} subdirectory.
| |
| | |
| == Staying up to date ==
| |
| | |
| In order to keep the kde4 installation up to date, each of the modules installed should be updated periodically. As Monday is the day for big changes in kdelibs, Tuesday may be the best day to do this. For each module checked out, run <tt>svn up</tt> and <tt>make</tt>.
| |
| | |
| For example:
| |
| <code bash>
| |
| cs kdesupport # cs is not a typo
| |
| svn up
| |
| cb # cb is not a typo
| |
| make install
| |
| </code>
| |
| | |
| Note: it is not necessary to run cmakekde for updates.
| |
| | |
| == Installing a subset of a module ==
| |
| | |
| Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the [http://websvn.kde.org/branches/KDE/4.0/kdegames/CMakeLists.txt?view=markup kdegames CMakeLists.txt file] lists:
| |
| | |
| <code>
| |
| add_subdirectory(libkdegames)
| |
| add_subdirectory(libkmahjongg)
| |
| | |
| macro_optional_add_subdirectory(doc)
| |
| macro_optional_add_subdirectory(lskat)
| |
| macro_optional_add_subdirectory(katomic)
| |
| </code>
| |
| | |
| So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship:
| |
| | |
| <code bash>
| |
| cs KDE
| |
| svn co -N kdegames # The -N switch performs a non-recursive checkout
| |
| cd kdegames
| |
| svn up libkdegames # Get required directories
| |
| svn up libkmahjongg
| |
| svn up cmake
| |
| svn up kbattleship # Get optional directories
| |
| svn up kmahjongg
| |
| cmakekde
| |
| </code>
| |
| | |
| == Success! ==
| |
| | |
| 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 [[Getting Started/Set up KDE 4 for development|Set up KDE 4 for development]] tutorial for how to start KDE 4 applications and how to use KDevelop to work on them.
| |
| | |
| [[Category:Build KDE]]
| |
| [[Category:KDE4]]
| |
