Centerlink (Talk | contribs) (Preliminary and still partly Finnish translation.) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
{{TutorialBrowser| | {{TutorialBrowser| | ||
| Line 7: | Line 7: | ||
name=Building KDE4 (Development version, TRUNK) From Source| | name=Building KDE4 (Development version, TRUNK) From Source| | ||
| − | pre=[[../../Sources/ | + | pre=[[../../Sources/Anonymous_SVN_(fi)|Anonyymi SVN-pikaohje]]| |
next=[[../../Set_up_KDE_4_for_development|Aseta KDE 4-kehitysympäristö]]| | next=[[../../Set_up_KDE_4_for_development|Aseta KDE 4-kehitysympäristö]]| | ||
| Line 16: | Line 16: | ||
== Yhteenveto == | == Yhteenveto == | ||
| − | + | Tämä kurssi esittää yhden tavan hakea KDE-versionhallinnan trunk-haara suoritettavaksi Linux/BSD-järjestelmissä. On olemassa myös kursseja [[Getting_Started/Build/KDE4/FreeBSD|FreeBSD:lle]], [[/Windows|Windowsille]], [[/Mac OS X|Mac OS X:lle]] and [http://solaris.kde.org/ Solarikselle]. Tämä kurssi luo erikoiskäyttäjän, kde-devel, joka suorittaa KDE-trunk-version. Toisaalta erityisen järjestelmänlaajuisen kuten esimerkiksi KDE-näyttöhallintakoodin testaus ei ole mahdollista. On olemassa myös kurssi [[Getting_Started/Build/KDE4/onVmWare|KDE 4 trunk-version asettamisesta virtuaalikoneeseen]]. | |
| − | [[Getting_Started/Build/KDE4/onVmWare| | + | |
Throughout the tutorial the bash shell is used. | Throughout the tutorial the bash shell is used. | ||
| Line 40: | Line 39: | ||
On Ark Linux and Fedora, you can skip the <tt>-s /bin/bash</tt> switch - {{path|/bin/sh}} is {{path|bash}}. | On Ark Linux and Fedora, you can skip the <tt>-s /bin/bash</tt> switch - {{path|/bin/sh}} is {{path|bash}}. | ||
}} | }} | ||
| − | < | + | <syntaxhighlight lang="bash"> |
useradd -m kde-devel -s /bin/bash | useradd -m kde-devel -s /bin/bash | ||
passwd kde-devel | passwd kde-devel | ||
| − | </ | + | </syntaxhighlight> |
| Line 58: | Line 57: | ||
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]]). | 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 | To make it run, you have to open a new bash or to execute | ||
| − | < | + | <syntaxhighlight lang="bash"> |
source ~/.bashrc | source ~/.bashrc | ||
| − | </ | + | </syntaxhighlight> |
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. | 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. | ||
| Line 68: | Line 67: | ||
=== Vaihdetaan uuteen käyttäjään === | === Vaihdetaan uuteen käyttäjään === | ||
Switch to the user kde-devel: | Switch to the user kde-devel: | ||
| − | < | + | <syntaxhighlight lang="bash"> |
ssh -X kde-devel@localhost | ssh -X kde-devel@localhost | ||
| − | </ | + | </syntaxhighlight> |
{{Note| | {{Note| | ||
| Line 193: | Line 192: | ||
: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. | :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 < | + | 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 <syntaxhighlight lang="bash">cd kdebase</syntaxhighlight> with <syntaxhighlight lang="bash">cd kdebase/runtime</syntaxhighlight> in the recipe below. |
=== Valmistusohje === | === Valmistusohje === | ||
| Line 238: | Line 237: | ||
For example: | For example: | ||
| − | < | + | <syntaxhighlight lang="bash"> |
cs kdesupport # cs is not a typo | cs kdesupport # cs is not a typo | ||
svn up | svn up | ||
cb # cb is not a typo | cb # cb is not a typo | ||
make install | make install | ||
| − | </ | + | </syntaxhighlight> |
Note: it is not necessary to run cmakekde for updates. | Note: it is not necessary to run cmakekde for updates. | ||
| Line 251: | Line 250: | ||
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: | 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: | ||
| − | < | + | <syntaxhighlight lang="text"> |
add_subdirectory(libkdegames) | add_subdirectory(libkdegames) | ||
add_subdirectory(libkmahjongg) | add_subdirectory(libkmahjongg) | ||
| Line 258: | Line 257: | ||
macro_optional_add_subdirectory(lskat) | macro_optional_add_subdirectory(lskat) | ||
macro_optional_add_subdirectory(katomic) | macro_optional_add_subdirectory(katomic) | ||
| − | </ | + | </syntaxhighlight> |
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: | 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: | ||
| − | < | + | <syntaxhighlight lang="bash"> |
cs KDE | cs KDE | ||
svn co -N svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames # The -N switch performs a non-recursive checkout | svn co -N svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames # The -N switch performs a non-recursive checkout | ||
| Line 272: | Line 271: | ||
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/kmahjongg | svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/kmahjongg | ||
cmakekde | cmakekde | ||
| − | </ | + | </syntaxhighlight> |
== Onnistui! == | == Onnistui! == | ||
| Tutorial Series | Getting Started |
| Previous | Anonyymi SVN-pikaohje |
| What's Next | Aseta KDE 4-kehitysympäristö |
| Further Reading | kdesvn-build: The KDE From Subversion Build Tool Sending Patches Increased Productivity in KDE4 with Scripts Introduction to CMake FreeBSD notes Instructions for Mac OS X Instructions for MS Windows |
Tämä kurssi esittää yhden tavan hakea KDE-versionhallinnan trunk-haara suoritettavaksi Linux/BSD-järjestelmissä. On olemassa myös kursseja FreeBSD:lle, Windowsille, Mac OS X:lle and Solarikselle. Tämä kurssi luo erikoiskäyttäjän, kde-devel, joka suorittaa KDE-trunk-version. Toisaalta erityisen järjestelmänlaajuisen kuten esimerkiksi KDE-näyttöhallintakoodin testaus ei ole mahdollista. On olemassa myös kurssi KDE 4 trunk-version asettamisesta virtuaalikoneeseen.
Throughout the tutorial the bash shell is used.
| Warning |
|---|
| Expect a higher risk of build failure on Mondays when most kdelibs changes are committed. Dashboard reports unexpected breakages. You are encouraged to fix failing modules. |
| 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 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 .bashrc, put them in a separate file that you source to switch to the KDE 4 environment. |
| Note |
|---|
| On some systems a new user is configured by default to use /bin/sh. Using /bin/sh can be very inconvenient to work with and you may want to change it to /bin/bash or another shell. On Ark Linux and Fedora, you can skip the -s /bin/bash switch - /bin/sh is bash. |
useradd -m kde-devel -s /bin/bash passwd kde-devel
| 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). |
Instead of using the commands above, you can also use the User module in the KDE Control Center if you already have KDE3 installed.
Copy the ~/.bashrc from your normal user account to the new kde-devel account. Next, copy and paste the contents of the example .bashrc into ~kde-devel/.bashrc. Be sure to comment out the line alias make=makeobj if you do not have the makeobj 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 this). To make it run, you have to open a new bash or to execute
source ~/.bashrc
This will provide access to commands such as cmakekde 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.
Switch to the user kde-devel:
ssh -X kde-devel@localhost
| Note |
|---|
| If the ssh command fails, check out the Launching KDE 4 apps section of the KDE4 development guide. |
The requirements to build kde4 from source vary from distribution to distribution. Instructions for your distribution are provided below:
Your next compilation step depends on the packages supplied by your distro.
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 CMake, Qt4 (kde-qt) and kdesupport are available in the build prerequisites page. Note that automoc, phonon, strigi, soprano, and a few other things are part of kdesupport, so if you have errors about these missing, you'll need to get kdesupport.
The commands below are used to build the latest unstable version of KDE from trunk. This should not be used in a production environment -- not recommended for daily use.
Stabiilin version rakentamiseksi mene:
| Warning |
|---|
| Do not use this method when you don't know what you are doing or just want to test some trunk feature, seriously! You can create a very costly load when you accidentially checkout all of trunk or for example all of "trunk/KDE" just to build single modules. This would generate immense useless load on the svn server. |
If you check out large parts of svn trunk regularly or if you want to create patches which touch several modules at once, you should try to checkout an empty tree of trunk first and then update only the relevant modules, for example:
cd cs # 'cs' is a bash function, click here to learn more svn checkout --depth empty svn://anonsvn.kde.org/home/kde/trunk cd trunk svn up kdesupport && cd kdesupport cmakekde cs trunk svn up --depth empty KDE svn up KDE/kdelibs && cd KDE/kdelibs cmakekde cs trunk svn up KDE/kdepimlibs ...
That way you can move stuff around all over the trunk repository, e.g. from playground to kdereview or to KDE/*. The following examples assume that you only want to test or work on single and few modules of trunk.
This way updating the whole repository to a (hopefully) consitent state, the same revision, is really easy:
cs trunk # 'cs' is a bash function, click here to learn more svn up
We can now move on to building KDE's base libraries.
cd cs # '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
We change to the base source directory (line 1) then make and go into the KDE directory (line 3). We download the sources for kdelibs using subversion (line 4), go into the new ~/kde/src/KDE/kdelibs directory (line 5), and commence the build (line 6). This will leave us in the kdelibs build directory after the build is completed.
| Tip |
|---|
| There might be missing dependencies on your system! They are easily overlooked in the output of cmakekde. You might want to do a cmake $KDE_SRC/KDE/MODULE_NAME prior to compiling any kde modules (like kdelibs, kdepimlibs etc.) |
There are additional CMake modules in 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
For troubleshooting information, see the kdelibs troubleshooting section.
Currently kdebase depends on kdepimlibs so it is required to install it first. These libraries are also shared by other packages such as those within kdepim, kdeutils and kdenetwork.
Download libical from http://sourceforge.net/project/showfiles.php?group_id=16077, compile, link and install it.
tar xvzf libical-0.41.tar.gz cd libical-0.41 ./configure && make && make install
cs KDE # 'cs' is a bash function, click here to learn more svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs cd kdepimlibs cmakekde
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 ~/kde/src/KDE/kdepimlibs directory (line 3). We then commence the build (line 4). This will leave us in the kdepimlibs build directory after the build is completed.
For troubleshooting information, see the kdepimlibs troubleshooting section.
kdebase is divided into three parts:
cd kdebasecd kdebase/runtime
cs KDE # 'cs' is a bash function, click here to learn more svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase cd kdebase cmakekde
For troubleshooting information, see the kdebase troubleshooting section.
Most KDE users are going to install translations before being able to use their desktop properly. Full information is given in the Localisation tutorial at Development/Tutorials/Localization/Building_KDE's_l10n_Module. For a single language, the following receipe installs messages and translated documentation:
cs KDE # 'cs' is a bash function, click here to learn more svn checkout -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4 cd l10n-kde4 svn checkout scripts <language> ./scripts/autogen.sh <language> cd <language> cmakekde
Voit nyt suorittaa KDE 4-ohjelmia (esim.: kwrite) kirjoittamalle:
ssh -X kde-devel@localhost kwrite
For troubleshooting issues see troubleshooting running programs.
See the generating apidox page.
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 svn up and make.
For example:
cs kdesupport # cs is not a typo svn up cb # cb is not a typo make install
Note: it is not necessary to run cmakekde for updates.
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 kdegames CMakeLists.txt file lists:
add_subdirectory(libkdegames) add_subdirectory(libkmahjongg) macro_optional_add_subdirectory(doc) macro_optional_add_subdirectory(lskat) macro_optional_add_subdirectory(katomic)
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:
cs KDE svn co -N svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames # The -N switch performs a non-recursive checkout cd kdegames svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/libkdegames # Get required directories svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/libkmahjongg svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/cmake svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/kbattleship # Get optional directories svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/kmahjongg cmakekde
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.
For further isolation of your development environment change symbolic links, which you will see after executing ls -lh $(kde4-config --localprefix), assuming newly installed kde4-config is called.
See the Set up KDE 4 for development tutorial for how to start KDE 4 applications and how to use KDevelop to work on them.
For most of what you need to know on patches see: Sending Patches