(Some changes to kdesvn-buildrc to reflect git modules)
m (moved Getting Started/Build/kdesvn-buildrc to Getting Started/Build/kdesrc-buildrc: it is being switched to src)
The kdesvn-build program, which is used to download, build, and install KDE from the KDE source repository, uses a file called kdesvn-buildrc in order to control what is downloaded and built, what options are used, and where KDE is installed to.
This is a description of how to use kdesvn-buildrc.
The kdesvn-build download will include a file called kdesvn-buildrc-sample, which is a sample configuration file suitable for building the KDE Software Compilation (SC).
To create your configuration, it is recommended to use this file as a base since it includes the standard list of KDE modules to build, in the correct order. (You can, of course, add or remove most modules if you like).
You can use any standard text editor to edit this file, such as KWrite, nano, vi, etc.
Once you open the file, you will see that it starts with some comments (on lines beginning with #), and then the world "global". This starts the global configuration for the kdesvn-buildrc, which is used to specify options which are common to all of the modules.
Each option in the global section is specified in the following form:
Many options are already listed, with default values, and comments about the option on top. Some options have more than one sample value listed. In this situation, all but one of these will have comments. If you want to use a different sample option, simply uncomment the line by deleting the '#' at the beginning, and commenting or deleting the other lines with the same option name.
Here's a short listing of some of the important global options:
|As you can see, there are three different major directories, source, build, and install. The build directory is used to keep the source directory clean and to hold intermediate files that don't get installed|
|You can use ~/ in these options to represent your home directory|
|qt-copy is a module specifically for building Nokia's Qt toolkit. See #qt-copy below for information about what is special.|
If this is the case for you, you can use this option (either globally, or for each module) to run make install using sudo, or su, etc.
After the global options are all done, you'll see the line "end global", which lets kdesvn-build know that all of the global options have been read.
Next in the kdesvn-buildrc are the module options. First off, modules are listed in the file, in the order they are to be built and installed. Each module is listed in the following format:
The module-name is how kdesvn-build refers to the module. It should match the name of the module you are downloading from the source repository. Base KDE modules are listed in WebSVN. Other modules are also available in WebSVN.
One exception is that modules downloaded from git can have any module name you'd like that isn't already used, as kdesvn-build determines their download location using a specific repository option.
For each module you can specify options, in the same fashion as for the global options. Most of the time, if you set an option for a module, it completely overrides the global option, if any.
However, the cmake-options for a module is added to the global cmake-options, instead of replacing it, which allows you to avoid having to give the same cmake-options for all of your modules.
|If you get the warning from kdesvn-build that a certain module is not listed in the kdesvn-buildrc, make sure that you've added it to the kdesvn-buildrc, even if you have no options for it. If it's already in the kdesvn-buildrc, make sure you spelled the module name right on the command line.|
The qt-copy module is special in that it uses configure-options instead of cmake-options, and it never inherits compilation flags that are set globally, since Qt uses a different build system than KDE software does. The sample kdesvn-buildrc contains a useful set of default configure flags, but if you aren't using qt-copy, you can simply comment the entire qt-copy module out.
Since Nokia's Qt is developed using git instead of Subversion, you must specify the repository option for qt-copy to choose which version of Qt you will use:
|Edition to build||Repository to use|
|Official Nokia Qt||git://gitorious.org/qt/qt.git|
|Slightly modified Qt with KDE-specific patches and bugfixes (recommended if you're going to the trouble anyways)||git://gitorious.org/+kde-developers/qt/kde-qt.git|
Either way you should specify a branch of master to choose the default version.
If you choose kde-qt make sure to look at the README.kde-qt after kdesvn-build downloads the module for you as well!
kdesvn-build will search in several locations for your rc file.
When you make changes to values in your kdesvn-buildrc, they may not always be picked up immediately. For example, if you change cmake-options but kdesvn-build has no reason to run CMake again, then you'll still be building with your old cmake-options.
|This is only partially true -- kdesvn-build will be able to note that some values have changed and automatically re-run affected build portions as appropriate, but this advice still applies until this feature has been integrated for all options|
The safest way to ensure that a change to your module's options is picked up is to use the --refresh-build option when rebuilding a module. This option causes kdesvn-build to completely rebuild the given module, which includes running cmake and clearing out the build directory.
Using --refresh-build takes the most time. Often, it is enough to use --reconfigure instead of --refresh-build, which runs CMake but does not clear out the build directory. But if --reconfigure doesn't work you'll end up doing --refresh-build anyways.
On the other hand, if you change the svn-server option to move where kdesvn-build is downloading from, you need to run kdesvn-build one time with the --svn-only option, so that kdesvn-build can perform the correct "svn switch" command.
The kdesvn-buildrc file is one of the major reasons to use kdesvn-build instead of building manually, as it will allow you to specify build settings to use all of the time instead of having to always remember to type in the correct command line settings and export the right environment variables. There are many more options than the ones covered here, which are mostly detailed at the kdesvn-build documentation. However, these options are enough to get you a working KDE installation.