http://docs.kde.org/
Prev Next

Chapter 4. Configuring kdesrc-build

Table of Contents

Overview of kdesrc-build configuration
Layout of the configuration file
Including other configuration files
Commonly used configuration options
Table of available configuration options

Overview of kdesrc-build configuration

To use the script, you must have a file in your home directory called .kdesrc-buildrc, which describes the modules you would like to download and build.

Layout of the configuration file

Global configuration

The configuration file starts with the global options, specified like the following: 

global
option-name option-value
[...]
end global

Module configuration

It is then followed by one or more module sections, specified in one of the following two forms: 

  • module module-name
option-name option-value
[...]
end module

  • module-set module-set-name
  repository kde-projects or git://host.org/path/to/repo.git
  use-modules module-names

# Other options may also be set
option-name option-value
[...]
end module-set

Important

Note that the second form, module sets, only works for Git-based modules.

For Subversion modules, module-name must be a module from the KDE Subversion repository (for example, kdeartwork or kde-wallpapers), although it is possible to get around this if you manually specify the Subversion URL.

For Git modules, the module name can be essentially whatever you'd like, as long as it does not duplicate any other module name in the configuration. Keep in mind the source and build directory layout will be based on the module name if you do not use the dest-dir option.

However, for Git module sets the module-names must correspond with actual git modules in the chosen repository. See git-repository-base or use-modules for more information.

Including other configuration files

Within the configuration file, you may reference other files by using the include keyword with a file, which will act as if the file referenced had been inserted into the configuration file at that point.

For example, you could have something like this:

global
    include ~/common-kdesrc-build-options

    # Insert specific options here.

end global

Commonly used configuration options

The following is a list of commonly-used options. Click on the option to find out more about it. To see the full list of options, see the section called “Table of available configuration options”.

  • cmake-options to define what flags to configure a module with using CMake.

  • branch, to checkout from a branch instead of /trunk (for Subversion) or master (for Git).

  • configure-flags to define what flags to configure Qt™ with.

  • kdedir, to set the directory to install KDE to.

  • make-options, to pass options to the Make program (such as number of CPUs to use).

  • qtdir, to set the path to Qt™.

  • source-dir, to change where to download the source code to.