diff --git a/README.md b/README.md index e1fb9c4..a31b23b 100644 --- a/README.md +++ b/README.md @@ -1,272 +1,272 @@ # kdesrc-build This script streamlines the process of setting up and maintaining a development environment for KDE software. It does this by automating the process of downloading source code from the KDE source code repositories, building that source code, and installing it to your local system. ## Note the Alternatives NOTICE! If you are a power user just trying to test the latest KDE releases like [KDE Plasma 5](https://www.kde.org/plasma-desktop) or the [KDE Applications](https://www.kde.org/applications/) then there are potentially easier options you may wish to consider first. KDE provides a quick-starter distribution, [KDE neon Developer Edition](https://neon.kde.org/download), and your favorite distribution may also have bleeding edge packages that may be easier to try out. However if you're testing out the latest KDE Frameworks or are involved in development yourself, you'll probably find it easiest to use kdesrc-build. Continue on, to learn how to set it up. ## QUICK HOWTO 1. Set up minimum dependencies - You must have at least [Perl](https://www.perl.org/get.html) version 5.14 installed. Most distributions include at least a minimal Perl set up, and Perl is also required for some portions of Qt and KDE software builds so it is good to have regardless. - You must have [Git](https://git-scm.com/) installed to download KDE sources and kdesrc-build itself. We recommend at least version 2.10. - You must have [dialog](https://invisible-island.net/dialog/) installed to run kdesrc-build-setup. 2. Install kdesrc-build: - Clone kdesrc-build from git, by running from a terminal: ```shell $ mkdir -p ~/kde/src $ cd ~/kde/src -$ git clone https://anongit.kde.org/kdesrc-build +$ git clone https://invent.kde.org/sdk/kdesrc-build.git $ cd kdesrc-build # kdesrc-build is in this directory ``` - Make sure it works by running: ```shell $ cd ~/kde/src/kdesrc-build $ ./kdesrc-build --version ``` You should see output similar to `kdesrc-build 18.10 (v18.10-20-g1c39943)`. Later we will set up kdesrc-build to keep itself updated automatically. 2. Set up kdesrc-build: - Now that kdesrc-build is installed and works, you need to set up kdesrc-build to work appropriately on your particular system. Do this by running the provided set up script to generate the **configuration file** (~/.kdesrc-buildrc): ```shell $ cd ~/kde/src/kdesrc-build $ ./kdesrc-build-setup ``` - Answer the questions given, but do not fret if you don't know what exactly you want to build, it is easy to edit the configuration later or just to re-run `kdesrc-build-setup` again. - This script will reference a standard configuration provided as part of the kdesrc-build repository that you downloaded earlier. As kdesrc-build self-updates, these changes will reflect for your configuration as well. 3. Download the KDE project and dependency data: ```shell $ cd ~/kde/src/kdesrc-build $ ./kdesrc-build --metadata-only ``` This will download information describing the KDE source repositories and their dependencies, which will help kdesrc-build figure out what to build. kdesrc-build will maintain this automatically, but running this step separately helps to verify that kdesrc-build can properly reach the KDE source repository and allows the `--pretend` option in the next step to provide more accurate output. 4. Verify kdesrc-build has a good build plan: ```shell $ cd ~/kde/src/kdesrc-build $ ./kdesrc-build --pretend ``` This will have kdesrc-build go through the steps that it would perform, but without actually doing them. kdesrc-build will do some basic pre-checks in this stage to ensure that required command-line commands are available, including `cmake`, `git`, `qmake`, and others. This is the last good chance to make sure that kdesrc-build is set the way you want it. If this command gives you a message that all modules were successfully built, you can move onto the next step. 5. Perform your first build: ```shell $ cd ~/kde/src/kdesrc-build $ ./kdesrc-build --stop-on-failure dolphin ``` This will build [Dolphin](https://www.kde.org/applications/system/dolphin/), the Plasma 5 file manager and its KDE-based dependencies. We choose Dolphin since it is a good test case to exercise the whole build process. For each module built, kdesrc-build will complete these steps: - Update source code (initial download or later update) - Set up the build system and configure source code with your options, if needed - Perform the build, if needed - Install the module The `--stop-on-failure` flag causes kdesrc-build to stop the first time a module fails to build, in case there are missing dependencies. If not set, kdesrc-build would otherwise try to build all the modules even if some fail. Hopefully everything will go well the first time, and kdesrc-build will be able to download and build all of the modules that you ask for. :) ## UPGRADING KDESRC-BUILD Upgrading is simple. You can delete your old kdesrc-build directory (make sure you don't have any local changes in there first, or your kdesrc-buildrc file!) and then install the new version where the old kdesrc-build directory used to be. In fact, it is recommended to use git to update kdesrc-build itself, so that kdesrc-build updates itself automatically when run. This is set up already in the sample configuration for KF5, where kdesrc-build is configured to update itself. One thing to keep in mind when using kdesrc-build to manage keeping itself up to date is that updates won't take effect until the *next* time you run kdesrc-build. You may want to edit your ~/.kdesrc-buildrc to make sure any new options are included. You should always read the changes for the new version however, as sometimes there are slight changes in behavior necessary to adapt to updates in the source repository. If you are running kdesrc-build from its git repository, you can use the "git log" command from inside the kdesrc-build source directory to see the latest changes. You can use the `./kdesrc-build --version` command to ensure that you have successfully upgraded kdesrc-build. ## SAMPLE CONFIGURATION A sample configuration file is included for demonstration purposes. You could copy it to your `~/.kdesrc-buildrc` and edit, but you should use the provided `kdesrc-build-setup` script instead. ## HELP!!! This is only a very cursory guide. For more information please see the KDE Community [Get Involved for Development](https://community.kde.org/Get_Involved/development) page. ## REFERENCE kdesrc-build includes a limited command-line description with the --help option. You can read the [kdesrc-build handbook](https://docs.kde.org/index.php?application=kdesrc-build) online. Once you've set up a KDE development environment, kdesrc-build itself can generate and build documentation (a handbook and a man page). The handbook would be available in KHelpCenter (help:/kdesrc-build), while the man page would be available in the KDE man pages or in the kdesrc-build build directory: ```shell $ cd ~/kde/build/kdesrc-build/doc $ man ./kdesrc-build.1 ``` You can also ask for help online on the #kde-devel channel of IRC (irc.kde.org). Additionally you can ask for help on the KDE support mailing lists, such as kde-devel@kde.org Finally you can drop me an email at mpyne@kde.org (although I have a job/family and therefore don't always have time to respond) ### Behind the Curtain For each build, kdesrc-build does several things: - Finds the configuration file (based on the --rc-file option or by looking for `kdesrc-buildrc` in the current directory and falling back to `~/.kdesrc-buildrc`) - Reads the configuration file to generate: - Default options to apply for each module - A list of modules to build. Modules can be grouped in "module-sets", but kdesrc-build converts each set to a list of modules. - Reduces the module list to modules chosen on the command line (either by name or through options like `--resume-from`). - For modules known to be KDE repositories (derived from a module-set using the special `kde-projects` repository): - If `--include-dependencies` is enabled, adds needed KDE modules into the build, then - Reorders KDE modules with respect to each other to ensure they are built in dependency order. - Builds each module in the resulting list of modules. This is broken into "phases", and each phase's output is logged to a specific directory for inspection later (by default, ~/kde/src/log). kdesrc-build takes some pains to do perform source code updates and builds in the way that a developer really would at the command line, using the same `git`, `cmake`, `make` commands a user would. This means that users are free to explore the source directory and build directory for a module without trampling on additional data maintained by kdesrc-build: kdesrc-build does nothing special in either the source or build directories. ### Important Command Line Options These options are the most useful. Others are documented at [the kdesrc-build online handbook](https://go.kde.org/u/ksbcmdline). | option | Description | | ------ | ----------------- | | `--include-dependencies` | Adds any missing modules that are needed for the modules being built. Only works for KDE modules. | | `--pretend` | Lists the actions kdesrc-build would take but doesn't actually do them. Useful for a double-check before a long build. | | `--resume-from` | Starts the build from the given module instead of building all modules. Can combine with `--stop-after` or `--stop-before`. | | `--resume-after` | Starts the build from *after* the given module, otherwise same as `--resume-from`. | | `--stop-before` | Stops the build just before the given module instead of building all modules. Can combine with `--resume-from` or `--resume-after`. | | `--stop-after` | Stops the build just *after* the given module, otherwise the same as `--stop-before`. | | `--no-src` | Perform module builds as normal but don't try to update source directories. Use this when you've updated source codes yourself. | | `--refresh-build` | Completely cleans under the module build directories before building. Takes more time but can help recover from a broken build directory set up. | ### Cleaning the build and install directories kdesrc-build will if possible avoid regenerating the build system and avoid complete rebuilds of existing modules. This avoids wasting significant amounts of time rebuilding source codes that have not changed, as all supported build systems are smart enough to rebuild when necessary. However it can sometimes happen that a rebuild is needed but wasn't detected. If this happens you can force a build directory to be fully rebuilt using the `--refresh-build` option to kdesrc-build. If all else fails and your development environment which was working fine now can't seem to upgrade modules anymore, another option is to consider deleting the install directory (~/kde/usr by default) completely and rebuilding everything (using `--refresh-build`), but this can take a significant amount of time! ## CONTACT INFO If you find a bug, please report it at the [KDE Bugzilla](https://bugs.kde.org/) If you have any questions, please let me know: Michael Pyne diff --git a/doc/index.docbook b/doc/index.docbook index 082cb1e..75b8587 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,4979 +1,4979 @@ Copyright (c) 2005 Carlos Leonhard Woelz Copyright (c) 2009 Burkhard Lück Copyright (c) 2007, 2011 Federico Zenith Copyright (c) 2009-2011 Yuri Chornoivan ... and possibly others. Check the git source repository for specifics. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in COPYING.DOC. The license will be included in the generated documentation as well. --> kdesrc-build"> BSD'> Git'> CMake'> Make'> Ninja'> SSH'> Cron'> Subversion'> Sudo'> URL'> configure-flags'> kdedir'> qtdir'> build-dir'> module-base-path'> override-url'> source-dir'> email-address'> email-on-compile-error'> colorful-output'> tag'> branch'> do-not-compile'> checkout-only'> svn-server'> make-install-prefix'> niceness'> set-env'> libpath'> binpath'> --nice'> --ignore-modules'> --resume-from'> --resume-after'> --reconfigure'> --refresh-build'> ]> &kdesrc-build; Script Manual &Michael.Pyne; &Michael.Pyne.mail; CarlosWoelz carloswoelz@imap-mail.com 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 Michael Pyne 2005 Carlos Woelz &FDLNotice; 2018-01-20 &kdesrc-build; 17.12 &kdesrc-build; is a script which builds and installs &kde; software directly from the &kde; project's source code repositories. KDE kdesdk SVN Subversion git KDE development kdesvn-build kdecvs-build Introduction A brief introduction to &kdesrc-build; What is &kdesrc-build;? &kdesrc-build; is a script to help the &kde; community install &kde; software from its &git; and &subversion; source repositories, and continue to update that software afterwards. It is particularly intended to support those who need to supporting testing and development of &kde; software, including users testing bugfixes and developers working on new features. The &kdesrc-build; script can be configured to maintain a single individual module, a full &plasma; desktop with &kde; application set, or somewhere in between. To get started, see , or continue reading for more detail on how &kdesrc-build; works and what is covered in this documentation. &kdesrc-build; operation <quote>in a nutshell</quote> &kdesrc-build; works by using the tools available to the user at the command-line, using the same interfaces available to the user. When &kdesrc-build; is run, the following sequence is followed: &kdesrc-build; reads in the command line and configuration file, to determine what to build, compile options to use, where to install, &etc; &kdesrc-build; performs a source update for each module. The update continues until all modules have been updated. Modules that fail to update normally do not stop the build – you will be notified at the end which modules did not update. Modules that were successfully updated are built, have their test suite run, and are then installed. To reduce the overall time spent, &kdesrc-build; will by default start building the code as soon as the first module has completed updating, and allow the remaining updates to continue behind the scenes. A very good overview of how &kde; modules are built, including informative diagrams, is provided on an online article discussing &kde;'s &krita; application. This workflow is what &kdesrc-build; automates for all &kde; modules. Documentation Overview This guide is an overview to describe the following aspects of &kdesrc-build; operation: An overview of the steps required to get started. Notable features. The configuration file syntax and options. The command line options. Also documented are the steps which you should perform using other tools (&ie; steps that are not automatically performed by &kdesrc-build;). Getting Started In this chapter, we show how to use the &kdesrc-build; to checkout modules from the &kde; repository and build them. We also provide a basic explanation of the &kde; source code structure and the steps you have to perform before running the script. All topics present in this chapter are covered with even more detail in the Build from Source article, at the &kde; Community Wiki. If you are compiling &kde; for the first time, it is a good idea to read it, or consult it as a reference source. You will find detailed information about packaging tools and requirements, common compilation pitfalls and strategies and information about running your new &kde; installation. Preparing the System to Build &kde; Setup a new user account It is recommended that you use a different user account to build, install, and run your &kde; software from, since less permissions are required, and to avoid interfering with your distribution's packages. If you already have &kde; packages installed, the best choice would be to create a different (dedicated) user to build and run the new &kde;. Leaving your system &kde; untouched also allows you to have an emergency fallback in case a coding mistake causes your latest software build to be unusable. You can do also setup to install to a system-wide directory (⪚ /usr/src/local) if you wish. This document does not cover this installation type, since we assume you know what you are doing. Ensure your system is ready to build &kde; software Before using the &kdesrc-build; script (or any other building strategy) you must install the development tools and libraries needed for &kde;. The nearly complete list of required tools can be found from the &kde; Community Wiki Build Requirements page. Here is a list of some of the things you will need: You will need &cmake;, this software is what &kde; uses to handle build-time configuration of the source code and generation of the specific build commands for your system. The required version will vary depending on what versions of &kde; software you are building (see TechBase for specifics), but with modern distributions the &cmake; included with your distribution should be quite sufficient. You must also install the source control clients needed to checkout the &kde; source code. This means you need at least the following: The Git source control manager, which is used for all &kde; source code Although it is not required, the Bazaar source control manager is used for a single module (libdbusmenu-qt) that is required for the &kde; libraries. Most users can install this library through their distribution packages but &kdesrc-build; supports building it as well if you desire. But to build libdbusmenu-qt, you must have Bazaar installed. The Perl scripting language is required for &kdesrc-build;, some &kde; repositories, and &Qt; (if you build that from source). The Perl that comes with your distribution should be suitable (it needs to be at least Perl 5.14), but you will also need some additional modules (&kdesrc-build; will warn if they are not present): IO::Socket::SSL JSON::PP or JSON::XS YAML::PP, YAML::XS, or YAML::Syck You will need a full C++ development environment (compiler, standard library, runtime, and any required development packages). The minimum required versions vary based on the &kde; module: the &kde; Frameworks 5 collection supports the oldest compilers, while &kde; Plasma 5 and &kde; Applications tend to require more recent compilers. The GCC 4.8 or Clang 4 compilers are the minimum recommended. Many distributions support easily installing these tools using a build-essentials package, an option to install "build dependencies" with &Qt;, or similar features. The KDE Community Wiki has a page tracking recommended packages for major distributions. You will need a build tool that actually performs the compilation steps (as generated by &cmake;). GNU Make is recommended and should be available through your package manager. &cmake; does support others options, such as the &ninja; build tool, which can be used by &kdesrc-build; using the custom-build-command configuration file option. Finally, you will need the appropriate &Qt; libraries (including development packages) for the version of &kde; software you are building. &kdesrc-build; does not officially support building &Qt; 5 (the current major version), so it is recommended to use your distribution's development packages or to see the KDE Community wiki page on self-building Qt 5. Most operating system distributions include a method of easily installing required development tools. Consult the Community Wiki page Required devel packages to see if these instructions are already available. Some of these packages are divided into libraries (or programs or utilities), and development packages. You will need at least the program or library and its development package. Setup &kdesrc-build; Install &kdesrc-build; The &kde; developers make frequent changes to &kdesrc-build; to keep it in sync with advances in &kde; development, including improvements to the recommended &kdesrc-build; configuration, added modules, improving &cmake; flags, &etc; Because of this, we recommend obtaining &kdesrc-build; directly from its source repository and then periodically updating it. You can obtain &kdesrc-build; from its source repository by running: -$ git +$ git Replace with the directory you would like to install to. You can update &kdesrc-build; later by running: $ cd $ git We recommend adding the &kdesrc-build; installation directory to your PATH environment variable, so that you can run &kdesrc-build; without having to fully specify its path every time. Prepare the configuration file &kdesrc-build; uses a configuration file (located at ~/.kdesrc-buildrc) to control which modules are built, where they are installed to, etc. You can use a program included with &kdesrc-build;, called kdesrc-build-setup in order to prepare a simple kdesrc-build configuration. You can then edit the ~/.kdesrc-buildrc from there to make any changes you see fit. kdesrc-build-setup itself runs from a terminal (instead of using a graphical interface), just like &kdesrc-build;, so you can use it even if you have no graphical interface available yet. Manual setup of configuration file You can also setup your configuration file manually, by copying the included sample configuration file kdesrc-buildrc-kf5-sample to ~/.kdesrc-buildrc and then editing the file. will be a useful reference for this, especially its table of configuration options. &kdesrc-build; contains many recommended configuration files to support &kde; Frameworks 5, &plasma; 5, and other &kde; applications. The kdesrc-build-setup refers to these files in the configuration file it generates, but you can also use them yourself. See for information on how to use other configuration files from your own ~/.kdesrc-buildrc. You can find more information about the syntax of the configuration file in and in . Setting the Configuration Data To use &kdesrc-build;, you should have a file in your home directory called .kdesrc-buildrc, which sets the general options and sets the modules you would like to download and build. It is possible to use different configuration files for &kdesrc-build;, which is described in . If you need to use multiple configurations, please see that section. Here, we will assume the configuration is stored in ~/.kdesrc-buildrc. The easiest way to proceed is to use the kdesrc-buildrc-kf5-sample file as a template, changing global options to match your wants, and also change the list of modules you want to build. The default settings should be appropriate to perform a &kde; build. Some settings that you may wish to alter include: kdedir, which changes the destination directory that your &kde; software is installed to. This defaults to ~/kde, which is a single-user installation. branch-group, which can be used to choose the appropriate branch of development for the &kde; modules as a whole. There are many supported build configurations but you will likely want to choose so that &kdesrc-build; downloads the latest code based on &Qt; 5 and &kde; Frameworks 5. &kdesrc-build; will use a default branch group if you do not choose one, but this default will change over time, so it's better to choose one so that the branch group does not change unexpectedly. source-dir, to control the directory &kdesrc-build; uses for downloading the source code, running the build process, and saving logs. This defaults to ~/kdesrc. cmake-options, which sets the options to pass to the &cmake; command when building each module. Typically this is used to set between debug or release builds, to enable (or disable) optional features, or to pass information to the build process about the location of required libraries. make-options, which sets the options used when actually running the make command to build each module (once &cmake; has established the build system). The most typical option is , where N should be replaced with the maximum number of compile jobs you wish to allow. A higher number (up to the number of logical CPUs your system has available) leads to quicker builds, but requires more system resources. Configuring Make for 4 compiles at once, with exceptions global make-options -j4 … end global … module-set big-module-set repository kde-projects use-modules calligra make-options -j2 # Reduced number of build jobs for just these modules end module-set Some very large Git repositories may swamp your system if you try to compile with a too many build jobs at one time, especially repositories like the &Qt; WebKit and &Qt; WebEngine repositories. To maintain system interactivity you may have to reduce the number of build jobs for specific modules. gives an example of how to do this. You may want to select different modules to build, which is described in . Using the &kdesrc-build; script With the configuration data established, now you are ready to run the script. Even if you still have some tweaking or other reading you wish to do, it is a good idea to at least load the &kde; project metadata. Loading project metadata From a terminal window, log in to the user you are using to compile &kde; software and execute the script: % kdesrc-build This command will setup the source directory and connect to the KDE &git; repositories to download the database of &kde; git repositories, and the database of dependency metadata, without making any further changes. It is useful to run this separately as this metadata is useful for other &kdesrc-build; commands. Previewing what will happen when kdesrc-build runs With the project metadata installed, it is possible to preview what &kdesrc-build; will do when launched. This can be done with the command line option. % ./kdesrc-build You should see a message saying that some packages were successfully built (although nothing was actually built). If there were no significant problems shown, you can proceed to actually running the script. % kdesrc-build This command will download the appropriate source code, and build and install each module in order, but will stop if a module fails to build (due to the option). Afterwards, you should see output similar to that in : Example output of a kdesrc-build run % kdesrc-build Updating kde-build-metadata (to branch master) Updating sysadmin-repo-metadata (to branch master) Building libdbusmenu-qt (1/200) No changes to libdbusmenu-qt source, proceeding to build. Compiling... succeeded (after 0 seconds) Installing.. succeeded (after 0 seconds) Building taglib (2/200) Updating taglib (to branch master) Source update complete for taglib: 68 files affected. Compiling... succeeded (after 0 seconds) Installing.. succeeded (after 0 seconds) Building extra-cmake-modules from <module-set at line 32> (3/200) Updating extra-cmake-modules (to branch master) Source update complete for extra-cmake-modules: 2 files affected. Compiling... succeeded (after 0 seconds) Installing.. succeeded (after 0 seconds) ... Building kdevelop from kdev (200/200) Updating kdevelop (to branch master) Source update complete for kdevelop: 29 files affected. Compiling... succeeded (after 1 minute, and 34 seconds) Installing.. succeeded (after 2 seconds) <<< PACKAGES SUCCESSFULLY BUILT >>> Built 200 modules Your logs are saved in /home/kde-src/kdesrc/log/2018-01-20-07 Resolving build failures Depending on how many modules you are downloading, it is possible that &kdesrc-build; will not succeed the first time you compile &kde; software. Do not despair! &kdesrc-build; logs the output of every command it runs. By default, the log files are kept in ~/kdesrc/log. To see what the caused an error for a module in the last &kdesrc-build; command, usually it is sufficient to look at ~/kdesrc/log/latest/module-name/error.log. Perhaps the easiest way to find out what error caused a module to fail to build is to search backward with a case-insensitive search, starting from the end of the file looking for the word error. Once that is found, scroll up to make sure there are no other error messages nearby. The first error message in a group is usually the underlying problem. In that file, you will see the error that caused the build to fail for that module. If the file says (at the bottom) that you are missing some packages, try installing the package (including any appropriate -dev packages) before trying to build that module again. Make sure that when you run &kdesrc-build; again to pass the --reconfigure option so that &kdesrc-build; forces the module to check for the missing packages again. Or, if the error appears to be a build error (such as a syntax error, incorrect prototype, unknown type, or similar) then it is probably an error with the &kde; source, which will hopefully be resolved within a few days. If it is not resolved within that time, feel free to mail the kde-devel@kde.org mailing list (subscription may be required first) in order to report the build failure. You can find more common examples of things that can go wrong and their solutions, as well as general tips and strategies to build &kde; software in the Build from Source. On the other hand, assuming everything went well, you should have a new &kde; install on your computer, and now it is simply a matter of running it, described next in . For more information about &kdesrc-build;'s logging features, please see . Building specific modules Rather than building every module all the time, you may only want to build a single module, or other small subset. Rather than editing your configuration file, you can simply pass the names of modules or module sets to build to the command line. Example output of a kdesrc-build specific module build % kdesrc-build dolphin Updating kde-build-metadata (to branch master) Updating sysadmin-repo-metadata (to branch master) Building extra-cmake-modules from frameworks-set (1/79) Updating extra-cmake-modules (to branch master) No changes to extra-cmake-modules source, proceeding to build. Running cmake... Compiling... succeeded (after 0 seconds) Installing.. succeeded (after 0 seconds) Building phonon from phonon (2/79) Updating phonon (to branch master) No changes to phonon source, proceeding to build. Compiling... succeeded (after 0 seconds) Installing.. succeeded (after 0 seconds) Building attica from frameworks-set (3/79) Updating attica (to branch master) No changes to attica source, proceeding to build. Compiling... succeeded (after 0 seconds) Installing.. succeeded (after 0 seconds) ... Building dolphin from base-apps (79/79) Updating dolphin (to branch master) No changes to dolphin source, proceeding to build. Compiling... succeeded (after 0 seconds) Installing.. succeeded (after 0 seconds) <<< PACKAGES SUCCESSFULLY BUILT >>> Built 79 modules Your logs are saved in /home/kde-src/kdesrc/log/2018-01-20-07 In this case, although only the dolphin application was specified, the flag caused &kdesrc-build; to include the dependencies listed for dolphin (by setting the include-dependencies option). The dependency resolution worked in this case only because dolphin happened to be specified in a kde-projects-based module set (in this example, named base-apps). See . Setting the Environment to Run Your &kde; &plasma; Desktop Assuming you are using a dedicated user to build &kde; &plasma;, and you already have an installed &plasma; version, running your new &plasma; may be a bit tricky, as the new &plasma; has to take precedence over the old. You must change the environment variables of your login scripts to make sure the newly-built desktop is used. Automatically installing a login driver Starting from version 1.16, &kdesrc-build; will try to install an appropriate login driver, that will allow you to login to your &kdesrc-build;-built &kde; desktop from your login manager. This can be disabled by using the configuration file option. Session setup does not occur while &kdesrc-build; is running in pretend mode. This driver works by setting up a custom xsession session type. This type of session should work by default with the &kdm; login manager (where it appears as a Custom session), but other login managers (such as LightDM and gdm) may require additional files installed to enable xsession support. Adding xsession support for distributions The default login managers for some distributions may require additional packages to be installed in order to support xsession logins. The Fedora &Linux; distribution requires the xorg-x11-xinit-session package to be installed for custom xsession login support. Debian and Debian-derived &Linux; distributions should support custom xsession logins, but require the option to be set in /etc/X11/Xsession.options. See also the Debian documentation on customizing the X session. For other distributions, go to . Manually adding support for xsession If there were no distribution-specific directions for your distribution in , you can manually add a Custom xsession login entry to your distribution's list of session types as follows: Adding an .xsession login session type. This procedure will likely require administrative privileges to complete. Create the file /usr/share/xsessions/kdesrc-build.desktop. Ensure the file just created has the following text: Type=XSession Exec=$HOME/.xsession Name=KDE Plasma Desktop (unstable; kdesrc-build) The $HOME entry must be replaced by the full path to your home directory (example, /home/user). The desktop entry specification does not allow for user-generic files. When the login manager is restarted, it should show a new session type, KDE Plasma Desktop (unstable; kdesrc-build) in its list of sessions, which should try to run the .xsession file installed by &kdesrc-build; if it is selected when you login. It may be easiest to restart the computer to restart the login manager, if the login manager does not track updates to the /usr/share/xsessions directory. Setting up the environment manually This documentation used to include instruction on which environment variables to set in order to load up the newly-built desktop. These instructions have been moved to an appendix (). If you intend to setup your own login support you can consult that appendix or view the sample-kde-env-master.sh file included with the &kdesrc-build; source. Module Organization and selection KDE Software Organization &kde; software is split into different components, many of which can be built by &kdesrc-build;. Understanding this organization will help you properly select the software modules that you want built. At the lowest level comes the &Qt; library, which is a very powerful, cross-platform toolkit library. &kde; is based on &Qt;, and some of the non-&kde; libraries required by &kde; are also based on &Qt;. &kdesrc-build; can build &Qt;, or use the one already installed on your system if it is a recent enough version. On top of &Qt; are required libraries that are necessary for &kde; software to work. Some of these libraries are not considered part of &kde; itself due to their generic nature, but are still essential to the &kde; Platform. These libraries are collected under a kdesupport module grouping but are not considered part of the Frameworks libraries. On top of these essential libraries come the &kde; Frameworks, sometimes abbreviated as KF5, which are essential libraries for the &kde; Plasma desktop, &kde; Applications, and other third-party software. On top of the Frameworks, come several different things: Third-party applications. These are applications that use the &kde; Frameworks or are designed to run under &kde; Plasma but are not authored by or in association with the &kde; project. Plasma, which is a full workspace desktop environment. This is what users normally see when they log-in to &kde;. The &kde; Application suite. This is a collection of useful software included with the Platform and &plasma; Desktop, grouped into individual modules, including utilities like &dolphin;, games like KSudoku, and productivity software released by &kde; such as &kontact;. Finally, there is a collection of software (also collected in modules) whose development is supported by &kde; resources (such as translation, source control, bug tracking, &etc;) but is not released by &kde; as part of Plasma or the Application suite. These modules are known as Extragear. Selecting modules to build Selecting which of the possible modules to build is controlled by the configuration file. After the global section is a list of modules to build, bracketed by module ... end module lines. An example entry for a module is shown in . Example module entry in the configuration file module kdesrc-build-git # Options for this module go here, example: repository kde:kdesrc-build make-options -j4 # Run 4 compiles at a time end module In practice, this module construct is not usually used directly. Instead most modules are specified via module-sets as described below. When using only module entries, &kdesrc-build; builds them in the order you list, and does not attempt to download any other repositories other than what you specify directly. Module Sets The &kde; source code is decomposed into a great number of relatively small Git-based repositories. To make it easier to manage the large number of repositories involved in any useful &kde;-based install, &kdesrc-build; supports grouping multiple modules and treating the group as a module set. The basic module set concept By using a module set, you can quickly declare many Git modules to be downloaded and built, as if you'd typed out a separate module declaration for each one. The repository option is handled specially to setup where each module is downloaded from, and every other option contained in the module set is copied to every module generated in this fashion. Using module sets global kde-git kde: end global module qt # Options removed for brevity end module module-set kde-support-libs kde-git automoc attica akonadi end module-set # Other modules as necessary... module kdesupport end module In a brief module set is shown. When &kdesrc-build; encounters this module set, it acts as if, for every module given in , that an individual module has been declared, with its equal to the module-set's followed immediately by the given module name. In addition, other options can be passed in a module set, which are copied to every new module that is created this way. By using module-set it is possible to quickly declare many Git modules that are all based on the same repository URL. In addition, it is possible to give module-sets a name (as shown in the example), which allows you to quickly refer to the entire group of modules from the command line. Special Support for KDE module sets The module set support described so far is general to any Git-based modules. For the &kde; Git repositories, &kdesrc-build; includes additional features to make things easier for users and developers. This support is enabled by specifying kde-projects as the for the module set. &kdesrc-build; normally only builds the modules you have listed in your configuration file, in the order you list them. But with a kde-projects module set, &kdesrc-build; can do dependency resolution of &kde;-specific modules, and in addition automatically include modules into the build even if only indirectly specified. Using kde-projects module sets # Only adds a module for juk (the kde/kdemultimedia/juk repo) module-set juk-set kde-projects juk end module-set # Adds all modules that are in kde/multimedia/*, including juk, # but no other dependencies module-set multimedia-set kde-projects kde/multimedia end module-set # Adds all modules that are in kde/multimedia/*, and all kde-projects # dependencies from outside of kde/kdemultimedia module-set multimedia-deps-set kde-projects kde/multimedia true end module-set # All modules created out of these three module sets are automatically put in # proper dependency order, regardless of the setting for include-dependencies This kde-projects module set construct is the main method of declaring which modules you want to build. All module sets use the repository and use-modules options. kde-projects module sets have a predefined value, but other types of module sets also will use the git-repository-base option. The official &kde; module database &kde;'s Git repositories allow for grouping related Git modules into collections of related modules (e.g. kdegraphics). Git doesn't recognize these groupings, but &kdesrc-build; can understand these groups, using module sets with a option set to kde-projects. &kdesrc-build; will recognize that the kde-projects repository requires special handling, and adjust the build process appropriately. Among other things, &kdesrc-build; will: Download the latest module database from the &kde; git archive. Try to find a module with the name given in the module set's setting in that database. For every module that is found, &kdesrc-build; will lookup the appropriate repository in the database, based upon the branch-group setting in effect. If a repository exists and is active for the branch group, &kdesrc-build; will automatically use that to download or update the source code. In the current database, some module groups not only have a collection of modules, but they also declare their own &git; repository. In these situations &kdesrc-build; will currently prefer the group's &git; repository instead of including the childrens' repositories. The following example shows how to use the &kde; module database to install the Phonon multimedia library. module-set media-support # This option must be kde-projects to use the module database. kde-projects # This option chooses what modules to look for in the database. phonon/phonon phonon-gstreamer phonon-vlc end module-set phonon/phonon is used since (with the current project database) &kdesrc-build; would otherwise have to decide between the group of projects called phonon or the individual project named phonon. Currently &kdesrc-build; would pick the former, which would build many more backends than needed. The following example is perhaps more realistic, and shows a feature only available with the &kde; module database: Building all of the &kde; graphics applications with only a single declaration. module-set kdegraphics # This option must be kde-projects to use the module database. kde-projects # This option chooses what modules to look for in the database. kdegraphics/libs kdegraphics/* end module-set There are two important abilities demonstrated here: &kdesrc-build; allows you to specify modules that are descendents of a given module, without building the parent module, by using the syntax module-name/*. It is actually required in this case since the base module, kdegraphics, is marked as inactive so that it is not accidentally built along with its children modules. Specifying the descendent modules allows &kdesrc-build; to skip around the disabled module. &kdesrc-build; will also not add a given module to the build list more than once. This allows us to manually set kdegraphics/libs to build first, before the rest of kdegraphics, without trying to build kdegraphics/libs twice. This used to be required for proper dependency handling, and today remains a fallback option in case the &kde; project database is missing dependency metadata. Filtering out &kde; project modules You might decide that you'd like to build all programs within a &kde; module grouping except for a given program. For instance, the kdeutils group includes a program named kremotecontrol. If your computer does not have the proper hardware to receive the signals sent by remote controls then you may decide that you'd rather not download, build, and install kremotecontrol every time you update kdeutils. You can achieve this by using the ignore-modules configuration option. Example for ignoring a kde-project module in a group module-set utils kde-projects # This option chooses what modules to look for in the database. kdeutils # This option "subtracts out" modules from the modules chosen by use-modules, above. kremotecontrol end module-set module-set graphics kde-projects # This option chooses what modules to look for in the database. extragear/graphics # This option "subtracts out" modules from the modules chosen by use-modules, above. # In this case, *both* extragear/graphics/kipi-plugins and # extragear/graphics/kipi-plugins/kipi-plugins-docs are ignored extragear/graphics/kipi-plugins end module-set Getting Started Conclusion These are the major features and concepts needed to get started with &kdesrc-build; For additional information, you could keep reading through this documentation. In particular, the list of command-line options and the table of configuration file options are useful references. The &kde; Community also maintains an online Wiki reference for how to build the source code, which refers to &kdesrc-build; and includes tips and other guidelines on how to use the tool. Script Features Feature Overview &kdesrc-build; features include: You can pretend to do the operations. If you pass or on the command line, the script will give a verbose description of the commands it is about to execute, without actually executing it. However if you've never run &kdesrc-build;, you would want to run the kdesrc-build command first in order for to work. For an even more verbose description of what &kdesrc-build; is doing, try using the option. &kdesrc-build; can (with the assistance of the &kde; FTP server) allow for speedy checkouts of some Subversion modules. If the module you are checking out has already been packaged at the website, then &kdesrc-build; will download the snapshot and prepare it for use on your computer. There is generally no need for any special preparation to perform the initial checkout of a Git module, as the entire Git repository must be downloaded anyways, so it is easy for the server to determine what to send. This is faster for you, and helps to ease the load on the kde.org anonymous &subversion; servers. Another speedup is provided by starting the build process for a module as soon as the source code for that module has been downloaded. (Available since version 1.6) Excellent support for building the &Qt; library (in case the &kde; software you are trying to build depends on a recent &Qt; not available in your distribution). &kdesrc-build; does not require a GUI present to operate. So, you can build &kde; software without needing a graphical environment. Supports setting default options for all modules (such as the compilation settings or the configuration options). Such options can normally be changed for specific modules as well. Also, &kdesrc-build; will add standard flags as appropriate to save you the trouble and possible errors from typing them yourself. Nota Bene: this does not apply when a (custom) toolchain is configured through e.g.: cmake-toolchain &kdesrc-build; can checkout a specific branch or tag of a module. You can also ensure that a specific revision is checked out of a module. &kdesrc-build; can automatically switch a source directory to checkout from a different repository, branch, or tag. This happens automatically when you change an option that changes what the repository &url; should be, but you must use the --src-only option to let &kdesrc-build; know that it is acceptable to perform the switch. &kdesrc-build; can checkout only portions of a module, for those situations where you only need one program from a large module. For developers: &kdesrc-build; will remind you if you use svn+ssh:// but ssh-agent is not running, as this will lead to repeated password requests from &ssh;. Can delete the build directory of a module after its installation to save space at the expense of future compilation time. The locations for the directories used by &kdesrc-build; are configurable (even per module). Can use &sudo;, or a different user-specified command to install modules so that &kdesrc-build; does not need to be run as the super user. &kdesrc-build; runs with reduced priority by default to allow you to still use your computer while &kdesrc-build; is working. Has support for using &kde;'s tags and branches. There is support for resuming a build from a given module. You can even ignore some modules temporarily for a given build. &kdesrc-build; will show the progress of your build when using &cmake;, and will always time the build process so you know after the fact how long it took. Comes built-in with a sane set of default options appropriate for building a base &kde; single-user installation from the anonymous source repositories. Tilde-expansion for your configuration options. For example, you can specify: qtdir ~/kdesrc/build/qt Automatically sets up a build system, with the source directory not the same as the build directory, in order to keep the source directory pristine. You can specify global options to apply to every module to check out, and you can specify options to apply to individual modules as well. Forced full rebuilds, by running &kdesrc-build; with the option. You can specify various environment values to be used during the build, including KDEDIR, QTDIR, DO_NOT_COMPILE, and CXXFLAGS. Command logging. Logs are dated and numbered so that you always have a log of a script run. Also, a special symlink called latest is created to always point to the most recent log entry in the log directory. You can check out only a portion of a &kde; &subversion; module. For example, you could check out only the taglib from kdesupport. &kdesrc-build;'s build logging Logging overview Logging is a &kdesrc-build; feature whereby the output from every command that &kdesrc-build; runs is saved to a file for examination later, if necessary. This is done because it is often necessary to have the output of these programs when there is a build failure, because there are so many reasons why a build can fail in the first place. Logging directory layout The logs are always stored under the log directory. The destination of the log directory is controlled by the log-dir option, which defaults to ${source-dir}/log (where ${source-dir} is the value of the source-dir option. The in rest of this section, this value will be referred to as ${log-dir}). Under ${log-dir}, is a set of directories, one for every time that &kdesrc-build; was run. Each directory is named with the date, and the run number. For instance, the second time that &kdesrc-build; is run on May 26, 2004, it would create a directory called 2004-05-26-02, where the 2004-05-26 is for the date, and the -02 is the run number. For your convenience, &kdesrc-build; will also create a link to the logs for your latest run, called latest. So the logs for the most recent &kdesrc-build; run should always be under ${log-dir}/latest. Now, each directory for a &kdesrc-build; run will itself contain a set of directories, one for every &kde; module that &kdesrc-build; tries to build. Also, a file called build-status will be contained in the directory, which will allow you to determine which modules built and which failed. If a module itself has a submodule (such as extragear/multimedia, playground/utils, or KDE/kdelibs), then there would actually be a matching layout in the log directory. For example, the logs for KDE/kdelibs after the last &kdesrc-build; run would be found in ${log-dir}/latest/KDE/kdelibs, and not under ${log-dir}/latest/kdelibs. In each module log directory, you will find a set of files for each operation that &kdesrc-build; performs. If &kdesrc-build; updates a module, you may see filenames such as svn-co.log (for a module checkout) or svn-up.log (when updating a module that has already been checked out). If the configure command was run, then you would expect to see a configure.log in that directory. If an error occurred, you should be able to see an explanation of why in one of the files. To help you determine which file contains the error, &kdesrc-build; will create a link from the file containing the error (such as build-1.log to a file called error.log). The upshot to all of this is that to see why a module failed to build after your last &kdesrc-build;, the file you should look at first is ${log-dir}/latest/module-name/error.log. If the file error.log is empty (especially after an installation), then perhaps there was no error. Some of the tools used by the &kde; build system will sometimes mistakenly report an error when there was none. Also, some commands will evade &kdesrc-build;'s output redirection and bypass the log file in certain circumstances (normally when performing the first &subversion; checkout), and the error output in that case is not in the log file but is instead at the &konsole; or terminal where you ran &kdesrc-build;. Configuring &kdesrc-build; 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, and any options or configuration parameters to use for these modules. 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 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 . See git-repository-base or use-modules for more information. <quote>options</quote> modules There is a final type of configuration file entry, options groups, which may be given wherever a module or module-set may be used. options module-name option-name option-value [...] end options An options group may have options set for it just like a module declaration, and is associated with an existing module. Any options set these way will be used to override options set for the associated module. The associated module name must match the name given in the options declaration. Be careful of mis-typing the name. This is useful to allow for declaring an entire module-set worth of modules, all using the same options, and then using options groups to make individual changes. options groups can also apply to named module sets. This allows expert users to use a common configuration file (which includes module-set declarations) as a baseline, and then make changes to the options used by those module-sets in configuration files that use the include command to reference the base configuration. Example of using options In this example we choose to build all modules from the &kde; multimedia software grouping. However we want to use a different version of the &kmix; application (perhaps for testing a bug fix). It works as follows: module-set kde-multimedia-set repository kde-projects use-modules kde/kdemultimedia branch master end module-set # kmix is a part of kde/kdemultimedia group, even though we never named # kmix earlier in this file, &kdesrc-build; will figure out the change. options kmix branch KDE/4.12 end options Now when you run &kdesrc-build;, all of the &kde; multimedia programs will be built from the master branch of the source repository, but &kmix; will be built from the older KDE/4.12 branch. By using options you didn't have to individually list all the other &kde; multimedia programs to give them the right branch option. Note that this feature is only available in &kdesrc-build; from version 1.16, or using the development version of &kdesrc-build; after 2014-01-12. 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 If you don't specify the full path to the file to include, then the file will be searched for starting from the directory containing the source file. This works recursively as well. 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 . 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. Table of available configuration options Here is a table of the various options, containing the following information: The option name A description of how &kdesrc-build; responds if the option is set in both the global section, and the module section of the configuration file while building a module. Special comments on the purpose and usage of the option. Table of Options Option-name Module -> Global Behavior Notes apidox This option was used to allow for building KDE module API documentation. It was removed in &kdesrc-build; 1.6.3 due to lack of support. Online API documentation is available from kde.org. In addition it is possible to build KDE API documentation using the kdedoxygen.sh script included in the kde-dev-scripts module. See KDE TechBase for more details. apply-qt-patches This option was removed in kdesrc-build 1.10. To get the same effect, see and the repository option. async Cannot be overridden This option enables the asynchronous mode of operation, where the source code update and the build process will be performed in parallel, instead of waiting for all of the source code updates before starting the build process. This option defaults to enabling asynchronous mode. To disable, set this option to false This option is available since the 1.6 release. binpath Module setting overrides global Set this option to set the environment variable PATH while building. You cannot override this setting in a module option. The default value is the $PATH that is set when the script starts. This environment variable should include the colon-separated paths of your development toolchain. The paths $KDEDIR/bin and $QTDIR/bin are automatically added. You may use the tilde (~) for any paths you add using this option. branch Module setting overrides global Set this option to checkout from a branch of &kde; instead of the default of master (for &git; modules) or trunk (for &subversion;), where &kde; development occurs. For instance, to checkout &kde; 4.6 branch, you would set this option to 4.6. If &kdesrc-build; fails to properly download a branch with this option, you may have to manually specify the &url; to download from using the module-base-path or override-url options. For most &kde; modules you probably wish to use the branch-group option instead and use this option for case-by-case exceptions. branch-group Module setting overrides global Set this option to a general group from which you want modules to be chosen. For supported &git; module types, &kdesrc-build; will determine the actual branch to use automatically based on rules encoded by the &kde; developers (these rules may be viewed in the kde-build-metadata source repository in your source directory). After a branch is determined that branch is used as if you had specified it yourself using the branch option. This is useful if you're just trying to maintain up-to-date on some normal development track without having to pay attention to all the branch name changes. The current branch groups (as of 2013-08-11) are: stable-qt4, for tracking bugfixes to the &Qt; 4-based &kde; libraries and applications. latest-qt4, for tracking development and new features for the &Qt; 4-based &kde; libraries and applications. kf5-qt5, for tracking bleeding-edge development for the upcoming &Qt; 5-based &kde; Frameworks 5, &plasma; Workspace 2, &etc; Note that if you do choose a branch yourself, that it will override this setting. The same is true of other specific branch selection options such as tag. This option was added in &kdesrc-build; 1.16-pre2. This option only applies to kde-projects &git; modules (the common case). See also . build-dir Module setting overrides global Use this option to change the directory to contain the built sources. There are three different ways to use it: Relative to the &kde; &subversion; source directory (see the source-dir option). This is the default, and is selected if you type a directory name that does not start with a tilde (~) or a slash (/). The default value is build. Absolute path. If you specify a path that begins with a /, then that path is used directly. For example, /tmp/kde-obj-dir/. Relative to your home directory. If you specify a path that begins with a ~, then the path is used relative to your home directory, analogous to the shell's tilde-expansion. For example, ~/builddir would set the build directory to /home/user-name/builddir. Perhaps surprisingly, this option can be changed per module. build-when-unchanged Module setting overrides global Use this option in order to control whether &kdesrc-build; always tries to build a module that has not had any source code updates. By setting to true, &kdesrc-build; always attempts the build phase for a module, even if the module did not have any source code updates. This is the default setting since it is more likely to lead to a correct build. By setting to false, &kdesrc-build; will only attempt to run the build phase for a module if the module has a source code update, or in other situations where it is likely that a rebuild is actually required. This can save time, especially if you run &kdesrc-build; daily, or more frequently. This feature is provided as an optimization only. Like many other optimizations, there are trade-offs for the correctness of your installation. For instance, changes to the qt or kdelibs modules may cause a rebuild of other modules to be necessary, even if the source code doesn't change at all. checkout-only Module setting overrides global Set this option to checkout &subversion; sources piece by piece. The value for this option should be a space-separated list of directories to checkout. Although this option overrides the global option, be aware that setting this as a global option makes no sense. Note that this setting has no effect on &git; modules due to the operation of the &git; source control system. See for an example. cmake-generator Module setting overrides global Use this option to specify which generator to use with &cmake;. Currently both Ninja and Unix Makefiles are supported. Invalid (unsupported) values are ignored and treated as if unset. If not set Unix Makefiles will be used by default. Note that if a valid generator is also specified through cmake-options it will override the value for cmake-generator. cmake-toolchain Module setting overrides global Use this option to specify a toolchain file to use with &cmake;. When a valid toolchain file is configured, &kdesrc-build; will no longer set environment variables automatically. You can use &set-env;, &binpath; and &libpath; to fix up the environment manually if your toolchain file does not work out of the box with &kdesrc-build;. Refer to the overview of standard flags added by &kdesrc-build; for more information. Note that if a valid toolchain is also specified through cmake-options it will override the value for cmake-toolchain. cmake-options Appends to global options for the default buildsystem, overrides global for other buildsystems. Use this option to specify what flags to pass to &cmake; when creating the build system for the module. When this is used as a global option, it is applied to all modules that this script builds. When used as a module option, it is added to the end of the global options. This allows you to specify common &cmake; options in the global section. This option does not apply to qt (which does not use &cmake;). Use configure-flags instead. If a valid generator is specified among the listed options it will override the value of cmake-generator. Invalid (unsupported) generators are ignored and will not be passed to &cmake;. If a valid toolchain file is specified among the listed options it will override the value of cmake-toolchain. Invalid toolchains are ignored and will not be passed to &cmake;. Since these options are passed directly to the &cmake; command line, they should be given as they would be typed into &cmake;. For example: cmake-options -DCMAKE_BUILD_TYPE=RelWithDebInfo Since this is a hassle, &kdesrc-build; takes pains to ensure that as long as the rest of the options are set correctly, you should be able to leave this option blank. (In other words, required &cmake; parameters are set for you automatically) colorful-output Cannot be overridden Set this option to false to disable the colorful output of &kdesrc-build;. This option defaults to true. Note that &kdesrc-build; will not output the color codes to anything but a terminal (such as xterm, &konsole;, or the normal &Linux; console). configure-flags Appends to global options for the default buildsystem, overrides global for other buildsystems. Use this option to specify what flags to pass to ./configure when creating the build system for the module. When this is used as a global-option, it is applied to all modules that this script builds. This option only works for qt. To change configuration settings for KDE modules, see cmake-options. custom-build-command Module setting overrides global (build system option) This option can be set to run a different command (other than make, for example) in order to perform the build process. &kdesrc-build; should in general do the right thing, so you should not need to set this option. However it can be useful to use alternate build systems. The value of this option is used as the command line to run, modified by the make-options option as normal. cxxflags Appends to global options for the default buildsystem, overrides global for other buildsystems. Use this option to specify what flags to use for building the module. This option is specified here instead of with configure-flags or cmake-options because this option will also set the environment variable CXXFLAGS during the build process. Note that for &kde; 4 and any other modules that use &cmake;, it is necessary to set the CMAKE_BUILD_TYPE option to none when configuring the module. This can be done using the cmake-options option. dest-dir Module setting overrides global Use this option to change the name a module is given on disk. For example, if your module was extragear/network, you could rename it to extragear-network using this option. Note that although this changes the name of the module on disk, it is not a good idea to include directories or directory separators in the name as this will interfere with any build-dir or source-dir options. disable-agent-check Cannot be overridden Normally if you are using &ssh; to download the &subversion; sources (such as if you are using the svn+ssh protocol), &kdesrc-build; will try and make sure that if you are using ssh-agent, it is actually managing some &ssh; identities. This is to try and prevent &ssh; from asking for your pass phrase for every module. You can disable this check by setting to true. do-not-compile Module setting overrides global Use this option to select a specific set of directories not to be built in a module (instead of all of them). The directories not to build should be space-separated. Note that the sources to the programs will still be downloaded. You can use the checkout-only directive to choose directories that you want to check out. For example, to hold &juk; and &kscd; in the kdemultimedia module from compiling, you would add "do-not-compile juk kscd" to your kdemultimedia settings. See for an example. email-address Cannot be overridden This option was removed in &kdesrc-build; 1.14. email-on-compile-error Cannot be overridden This option was removed in &kdesrc-build; 1.14. inst-apps This option was removed in version 1.10 git-desired-protocol Cannot be overridden This option only applies to modules from a &kde; project repository. What this option actually does is configure which network protocol to prefer when pushing source code for these modules. Normally the very-efficient git protocol is used, but this may be blocked in some networks (e.g. corporate intranets, public Wi-Fi). An alternative protocol which is much better supported is the https protocol used for Internet web sites. If you are using one of these constrained networks you can set this option to http to prefer https communications instead. You may also need the http-proxy option if an HTTP proxy is also needed for network traffic. In any other situation you should not set this option as the default protocol is most efficient. This option was added in &kdesrc-build; 1.16. Prior to 20.06 this option was used to configure the fetch URL instead of the push URL. As of 20.06 https is always used when updating KDE projects. git-repository-base Cannot be overridden This option, added in version 1.12.1, is used to create a short name to reference a specific Git repository base URL in later module set declarations, which is useful for quickly declaring many Git modules to build. You must specify two things (separated by a space): The name to assign to the base URL, and the actual base URL itself. For example: global # other options # This is the common path to all anonymous Git server modules. git-repository-base kde-git kde: end global # Module declarations module-set # Now you can use the alias you defined earlier, but only # in a module-set. repository kde-git use-modules module1.git module2.git end module-set The module-set's use-modules option created two modules internally, with &kdesrc-build; behaving as if it had read: module module1 repository kde:module1.git end module module module2 repository kde:module2.git end module The kde: &git; repository prefix used above is a shortcut which will be setup by &kdesrc-build; automatically. See the TechBase URL Renaming article for more information. Note that unlike most other options, this option can be specified multiple times in order to create as many aliases as necessary. It is not required to use this option to take advantage of module-set, this option exists to make it easy to use the same repository across many different module sets. git-user Module setting overrides global This option is intended for &kde; developers. If set, it will be used to automatically setup identity information for the &git; source control software for newly downloaded &git; modules (including the vast majority of &kde; modules). Specifically, the user's name and email fields for each new &git; repository are filled in to the values set by this option. The value must be specified in the form . For instance, a developer named Foo Barbaz with the email address foo@abc.xyz would use: git-user Foo Barbaz <foo@abc.xyz> This option was introduced in &kdesrc-build; 15.09. http-proxy Module setting overrides global This option, if set, uses the specified URL as a proxy server to use for any HTTP network communications (for example, when downloading snapshots for new modules, or the KDE project database). In addition, &kdesrc-build; will try to ensure that the tools it depends on also use that proxy server, if possible, by setting the http_proxy environment variable to the indicated server, if that environment variable is not already set. This option was introduced with &kdesrc-build; 1.16. ignore-kde-structure Module setting overrides global This option is used to store the source and the build files directly in the name of the module. For example, source/extragear/network/telepathy/ktp-text-ui becomes source/ktp-text-ui. This option is disabled by default. If you want to enable this option you need to set it to true. This option was introduced with &kdesrc-build; 1.16. ignore-modules Can't be overridden Modules named by this option, which would be chosen by &kdesrc-build; due to a use-modules option, are instead skipped entirely. Use this option when you want to build an entire kde-projects project grouping except for some specific modules. The option value does not necessarily have to name the module directly. Any module that has full consecutive parts of its &kde; projects module path match one of the option values will be ignored, so you can ignore multiple modules this way. For example, an option value of libs would result in both kde/kdegraphics/libs and playground/libs being excluded (though not kde/kdelibs since the full part kdelibs is what is compared). See also . This option was introduced with &kdesrc-build; 1.16. include-dependencies Module setting overrides global This option, when set to true requests that &kdesrc-build; also include known dependencies of this module in its build, without requiring you to mention those dependencies (even indirectly). This option only works for kde-project-based modules, and requires that the metadata maintained by the &kde; developers is accurate for your selected branch-group. This option is enabled by default, to support building applications that need versions of &Qt; or &plasma; more recent than supported on common operating systems. install-after-build Module setting overrides global This option is used to install the package after it successfully builds. This option is enabled by default. If you want to disable this, you need to set this option to false in the configuration file. You can also use the command line flag. install-environment-driver Cannot be overridden By default, &kdesrc-build; will install a shell script that can be sourced in a user's profile setup scripts to easily establish needed environment variables to run the Plasma desktop built by &kdesrc-build;. This driver will alter the following files: $XDG_CONFIG_HOME/kde-env-master.sh (normally found at ~/.config/kde-env-master.sh). $XDG_CONFIG_HOME/kde-env-user.sh (normally found at ~/.config/kde-env-user.sh). The kde-env-user.sh is optional. It is intended for user customizations (see the Troubleshooting and Debugging section of the &kde; UserBase for examples of customizable settings), but these settings can be set elsewhere by the user in their existing profile setup scripts. You can disable this feature by setting this option to false, and ensuring that the install-session-driver option is also disabled. This option was introduced with &kdesrc-build; 17.08. &kdesrc-build; will not overwrite your existing files (if present) unless you also pass the command-line option. install-session-driver Cannot be overridden If enabled, &kdesrc-build; will try to install a driver for the graphical login manager that allows you to login to your &kdesrc-build;-built &kde; desktop. This driver will alter the following files: ~/.xsession $XDG_CONFIG_HOME/kde-env-master.sh (normally found at ~/.config/kde-env-master.sh). $XDG_CONFIG_HOME/kde-env-user.sh (normally found at ~/.config/kde-env-user.sh). If you maintain your own login driver then you can disable this feature by setting this option to false. If enabled, this feature also enables the install-environment-driver feature. This option was introduced with &kdesrc-build; 1.16. &kdesrc-build; will not overwrite your existing files (if present) unless you also pass the command-line option. kdedir Module setting overrides global This option sets the directory that &kde; will be installed to after it is built. It defaults to ~/kde. If you change this to a directory needing root access, you may want to read about the make-install-prefix option as well. kde-languages Cannot be overridden This option allows you to choose to download and install localization packages along with &kde;. You might do this if you do not live in the United States and would like to use &kde; translated into your native language. To use this option, set it to a space-separated list of languages to install. Each language has a language code associated with it, which you can look up at this page: http://l10n.kde.org/teams-list.php. It is alright to choose only one language. By default, none are downloaded, which means &kde; will display in American English. For instance, to choose to install French, you would set the option to something like: fr. You would still need to use &systemsettings; in order to choose the French language, however. libpath Module setting overrides global Set this option to set the environment variable LD_LIBRARY_PATH while building. You cannot override this setting in a module option. The default value is blank, but the paths $KDEDIR/lib and $QTDIR/lib are automatically added. You may use the tilde (~) for any paths you add using this option. log-dir Module setting overrides global Use this option to change the directory used to hold the log files generated by the script. make-install-prefix Module setting overrides global Set this variable to a space-separated list, which is interpreted as a command and its options to precede the make command used to install modules. This is useful for installing packages with &sudo; for example, but please be careful while dealing with root privileges. make-options Module setting overrides global (build system option) Set this variable in order to pass command line options to the make command. This is useful for programs such as distcc or systems with more than one processor core. Note that not all supported build systems use make. For build systems that use ninja for build (such as the Meson build system), see the ninja-options setting. manual-build Module setting overrides global Set the option value to true to keep the build process from attempting to build this module. It will still be kept up-to-date when updating from &subversion;. This option is exactly equivalent to the command line option. manual-update Module setting overrides global Set the option value to true to keep the build process from attempting to update (and by extension, build or install) this module. If you set this option for a module, then you have essentially commented it out. module-base-path Module setting overrides global Set this option to override &kdesrc-build;'s default directory path to the module in question. This can be used, for example, to pull specific branches or tagged versions of libraries. The &kde; Source Viewer is invaluable in helping to pick the right path. Note that &kdesrc-build; constructs the final path according to the following template: $svn-server/home/kde/$module-base-path. The default value is either trunk/$module or trunk/KDE/$module, depending on the module name. Use the branch or tag options instead whenever they are applicable. niceness Cannot be overridden Set this option to a number between 20 and 0. The higher the number, the lower a priority &kdesrc-build; will set for itself, i.e. the higher the number, the "nicer" the program is. The default is 10. ninja-options Module setting overrides global (build system option) Set this variable in order to pass command line options to the ninja build command. This can be useful to enable verbose output or to manually reduce the number of parallel build jobs that ninja would use. Note that this setting only controls ninja when used by &kdesrc-build;. The &Qt; webengine module uses ninja indirectly, but only officially supports being built by make. In this situation, you can set NINJAFLAGS as a way to have make pass the appropriate flags when it later calls ninja, by using make-options. options qtwebengine # Restrict make and ninja to using no more than 6 separate compile jobs even # when more CPU is available, to avoid running out of memory -j6 NINJAFLAGS=-j6 end options no-svn Module setting overrides global If this option is set to true then &kdesrc-build; will not update the source code for the module automatically. It will still try to build the module if it normally would have tried anyways. no-rebuild-on-fail This option was removed in version 1.10, since this behavior no longer helps due to fixes in the underlying build system. override-build-system Module setting overrides global This is an advanced option, added in &kdesrc-build; 1.16. Normally &kdesrc-build; will detect the appropriate build system to use for a module after it is downloaded. This is done by checking for the existence of specific files in the module's source directory. Some modules may include more than one required set of files, which could confuse the auto-detection. In this case you can manually specify the correct build type. Currently supported build types that can be set are: KDE Used to build &kde; modules. In reality it can be used to build almost any module that uses &cmake; but it is best not to rely on this. Qt Used to build the &Qt; library itself. qmake Used to build &Qt; modules that use qmake-style .pro files. generic Used to build modules that use plain Makefiles and that do not require any special configuration. autotools This is the standard configuration tool used for most Free and open-source software not in any of the other categories. meson This is a relatively new tool gaining popularity as a replacement for the autotools and may be required for some non-&kde; modules. override-url Module setting overrides global If you set this option, &kdesrc-build; will use its value as the &url; to pass to &subversion; completely unchanged. You should generally use this if you want to download a specific release but &kdesrc-build; cannot figure out what you mean using branch. persistent-data-file Cannot be overridden Use this option to change where &kdesrc-build; stores its persistent data. The default is to store this data in a file called .kdesrc-build-data placed in the same directory as the configuration file in use. If you have multiple available configurations in the same directory you may want to manually set this option so that the different configurations do not end up with conflicting persistent data. This option was added with &kdesrc-build; 1.15. prefix Module setting overrides global This option controls where to install the module (normally the setting is used). Using this option allows you to install a module to a different directory than where the KDE Platform libraries are installed, such as if you were using &kdesrc-build; only to build applications. You can use ${MODULE} or $MODULE in the path to have them expanded to the module's name. purge-old-logs Module setting overrides global This option controls whether old log directories are automatically deleted or not. The default value is true. qmake-options Module setting overrides global Any options specified here are passed to the qmake command, for modules that use the qmake build system. For instance, you can use the PREFIX=/path/to/qt option to qmake to override where it installs the module. This option was added to &kdesrc-build; 1.16. qtdir Module setting overrides global Set this option to set the environment variable QTDIR while building. If you do not specify this option, &kdesrc-build; will assume that &Qt; is provided by the operating system. remove-after-install Module setting overrides global If you are low on hard disk space, you may want to use this option in order to automatically delete the build directory (or both the source and build directories for one-time installs) after the module is successfully installed. Possible values for this option are: none - Do not delete anything (This is the default). builddir - Delete the build directory, but not the source. all - Delete both the source code and build directory. Note that using this option can have a significant detrimental impact on both your bandwidth usage (if you use all) and the time taken to compile &kde; software, since &kdesrc-build; will be unable to perform incremental builds. repository Module setting overrides global This option was introduced with version 1.10, and is used to specify the &git; repository to download the source code for the module. &Qt; (and therefore qt) would need this option, as well as various &kde; modules that are in the process of conversion to use &git;. revision Module setting overrides global If this option is set to a value other than 0 (zero), &kdesrc-build; will force the source update to bring the module to the exact revision given, even if options like branch are in effect. If the module is already at the given revision then it will not be updated further unless this option is changed or removed from the configuration. This option did not work for git-based modules (including kde-projects modules) until &kdesrc-build; version 1.16. run-tests Module setting overrides global (build system option) If set to true, then the module will be built with support for running its test suite, and the test suite will be executed as part of the build process. &kdesrc-build; will show a simple report of the test results. This is useful for developers or those who want to ensure their system is setup correctly. set-env Module setting overrides global This option accepts a space-separated set of values, where the first value is the environment variable to set, and the rest of the values is what you want the variable set to. For example, to set the variable RONALD to McDonald, you would put in the appropriate section this command: set-env RONALD McDonald This option is special in that it can be repeated without overriding earlier set-env settings in the same section of the configuration file. This way you can set more than one environment variable per module (or globally). source-dir Module setting overrides global This option is used to set the directory on your computer to store the &kde; &subversion; sources at. If you do not specify this value, the default is ~/kdesrc. You may use the tilde (~) to represent the home directory if using this option. ssh-identity-file Cannot be overridden Set this option to control which private SSH key file is passed to the ssh-add command when &kdesrc-build; is downloading source code from repositories that require authentication. See also: . This option was added in version 1.14.2. stop-on-failure Module setting overrides global Set this option value to true to cause the script to stop execution after an error occurs during the build or install process. This option is off by default. svn-server Module setting overrides global This option is used to set the server used to check out from &subversion;. The default is the anonymous &subversion; repository, svn://anonsvn.kde.org/ If you are developing for KDE, use the &subversion; repository that was provided to you when you received your developer account, instead of the anonymous repository. tag Module setting overrides global Use this option to download a specific release of a module. Note: The odds are very good that you do not want to use this option. &kde; releases are available in tarball form from the &kde; download site. This option has only been supported for git-based modules since &kdesrc-build; 1.16. use-clean-install Module setting overrides global (build system option) Set this option to true in order to have &kdesrc-build; run make uninstall directly before running make install. This can be useful in ensuring that there are not stray old library files, &cmake; metadata, etc. that can cause issues in long-lived &kde; installations. However this only works on build systems that support make uninstall. This option was added with &kdesrc-build; 1.12, but was not documented until &kdesrc-build; 1.16. use-cmake This option was removed in &kdesrc-build; 1.4 as all &kde; 4 modules require &cmake;, and &cmake; use is not permitted on any other modules. use-idle-io-priority Cannot be overridden This option, added in &kdesrc-build; 1.12, will cause a lower priority to be used for disk and other I/O usage, which can significantly improve the responsiveness of the rest of the system at the expense of slightly longer running times for &kdesrc-build;. The default is to be disabled, to enable the lower disk priority set this to true. use-modules Can only use in module-set This option, added in &kdesrc-build; 1.12.1, allows you to easily specify many different modules to build at the same point in the configuration file. This option must be used within a module-set. Every identifier passed to this option is internally converted to a &kdesrc-build; module, with a option set to the module-set's repository combined with the identifier name in order to setup the final repository to download from. All other options that are assigned in the module-set are also copied to the generated modules unaltered. The order that modules are defined in this option is important, because that is also the order that &kdesrc-build; will process the generated modules when updating, building, and installing. All modules defined in the given module-set will be handled before &kdesrc-build; moves to the next module after the module-set. If you need to change the options for a generated module, simply declare the module again after it is defined in the module-set, and set your options as needed. Although you will change the options set for the module this way, the module will still be updated and built in the order set by the module-set (i.e. you can't reorder the build sequence doing this). The name to use for the module if you do this is simply the name that you passed to , with the exception that any .git is removed. See and git-repository-base for a description of its use and an example. use-qt-builddir-hack Module setting overrides global This option has been removed due to improvements in the &Qt; build system. use-stable-kde Can't be overridden This option is deprecated and will be removed (again) in a future release. Please use the instead, which offers more selectivity.
Command Line Options and Environment Variables Command Line Usage &kdesrc-build; is designed to be run as follows: kdesrc-build --options modules to build If no modules to build are specified on the command line, then kdesrc-build will build all modules defined in its configuration file, in the order listed in that file (although this can be modified by various configuration file options). Commonly used command line options The full list of command line options is given in . The most-commonly used options include: (or ) This option causes &kdesrc-build; to indicate what actions it would take, without actually really implementing them. This can be useful to make sure that the modules you think you are building will actually get built. This option forces &kdesrc-build; to build the given modules from an absolutely fresh start point. Any existing build directory for that module is removed and it is rebuilt. This option is useful if you have errors building a module, and sometimes is required when &Qt; or &kde; libraries change. This option skips the source update process. You might use it if you have very recently updated the source code (perhaps you did it manually or recently ran &kdesrc-build;) but still want to rebuild some modules. This option is similar to above, but this time the build process is skipped. Specifying modules to build In general, specifying modules to build is as simple as passing their module name as you defined it in the configuration file. You can also pass modules that are part of a module set, either as named on use-modules, or the name of the entire module set itself, if you have given it a name. In the specific case of module sets based against the KDE project database, &kdesrc-build; will expand module name components to determine the exact module you want. For example, &kdesrc-build;'s KDE project entry locates the project in extragear/utils/kdesrc-build. You could specify any of the following to build &kdesrc-build;: % kdesrc-build % kdesrc-build % kdesrc-build The commands in the previous example preceded the module-name with a +. This forces the module name to be interpreted as a module from the KDE project database, even if that module hasn't been defined in your configuration file. Be careful about specifying very generic projects (e.g. extragear/utils by itself), as this can lead to a large amount of modules being built. You should use the option before building a new module set to ensure it is only building the modules you want. Supported Environment Variables &kdesrc-build; does not use environment variables. If you need to set environment variables for the build or install process, please see the set-env option. Supported command-line parameters The script accepts the following command-line options: --async Enables the asynchronous mode, which can perform the source code updates and module builds at the same time. This is the default, this option only needs specified if you have disabled it in the configuration. --help Only display simple help on this script. --version (or -v) Display the program version. --show-info Displays information about &kdesrc-build; and the operating system, that may prove useful in bug reports or when asking for help in forums or mailing lists. Available since version 18.11. --initial-setup Has &kdesrc-build; perform the one-time initial setup necessary to prepare the system for &kdesrc-build; to operate, and for the newly-installed &kde; software to run. This includes: Installing known dependencies (on supported &Linux; distributions) Adding required environment variables to ~/.bashrc Setting up a configuration file Available since version 18.11. --author Display contact information for the author. --color Enable colorful output. (This is the default for interactive terminals). --nice=value This value adjusts the computer CPU priority requested by &kdesrc-build;, and should be in the range of 0-20. 0 is highest priority (because it is the least nice), 20 is lowest priority. &kdesrc-build; defaults to 10. --no-async Disables the asynchronous mode of updating. Instead the update will be performed in its entirety before the build starts. This option will slow down the overall process, but if you encounter IPC errors while running &kdesrc-build; try using this option, and submitting a bug report. --no-color Disable colorful output. --pretend (or -p) &kdesrc-build; will run through the update and build process, but instead of performing any actions to update or build, will instead output what the script would have done (e.g. what commands to run, general steps being taken, etc.). Simple read-only commands (such as reading file information) may still be run to make the output more relevant (such as correctly simulating whether source code would be checked out or updated). This option requires that some needed metadata is available, which is normally automatically downloaded, but downloads are disabled in pretend mode. If you've never run &kdesrc-build; (and therefore, don't have this metadata), you should run kdesrc-build to download the required metadata first. --quiet (or -q) Do not be as noisy with the output. With this switch only the basics are output. --really-quiet Only output warnings and errors. --verbose Be very descriptive about what is going on, and what &kdesrc-build; is doing. --src-only (or --svn-only) Only perform the source update. (The --svn-only is only supported for compatibility with older scripts). --build-only Only perform the build process. --install-only Only perform the install process. --metadata-only Only perform the metadata download process. &kdesrc-build; normally handles this automatically, but you might manually use this to allow the command line option to work. --rebuild-failures Use this option to build only those modules which failed to build on a previous &kdesrc-build; run. This is useful if a significant number of failures occurred mixed with successful builds. After fixing the issue causing the build failures you can then easily build only the modules that failed previously. Note that the list of previously-failed modules is reset every time a &kdesrc-build; run finishes with some module failures. However it is not reset by a completely successful build, so you can successfully rebuild a module or two and this flag will still work. This option was added for &kdesrc-build; 15.09. --include-dependencies --no-include-dependencies This option causes &kdesrc-build; to automatically include other &kde; and &Qt; modules in the build, if required for the modules you have requested to build on the command line or in your configuration file. The modules that are added are as recorded within the &kde; source code management system. See . The corresponding configure file option is include-dependencies. You can also use --no-include-dependencies, which turns off automatic inclusion of additional dependency modules. --ignore-modules Do not include the modules passed on the rest of the command line in the update/build process (this is useful if you want to build most of the modules in your configuration file and just skip a few). --no-src (or --no-svn) Skip contacting the &subversion; server. (The --no-svn parameter is only supported for compatibility with older versions of the script). --no-build Skip the build process. --no-metadata Do not automatically download the extra metadata needed for &kde; git modules. The source updates for the modules themselves will still occur unless you pass --no-src as well. This can be useful if you are frequently re-running &kdesrc-build; since the metadata does not change very often. But note that many other features require the metadata to be available. You might want to consider running &kdesrc-build; with the --metadata-only option one time and then using this option for subsequent runs. --no-install Do not automatically install packages after they are built. --no-build-when-unchanged --force-build This option explicitly disables skipping the build process (an optimization controlled by the build-when-unchanged option). This is useful for making &kdesrc-build; run the build when you have changed something that &kdesrc-build; cannot check. --force-build performs the exact same function, and is perhaps easier to remember. --debug Enables debug mode for the script. Currently this means that all output will be dumped to the standard output in addition to being logged in the log directory like normal. Also, many functions are much more verbose about what they are doing in debugging mode. --query=mode This command causes &kdesrc-build; to query a parameter of the modules in the build list (either passed on the command line or read in from the configuration file), outputting the result to screen (one module per line). This option must be provided with a query mode, which should be one of the following: , which causes &kdesrc-build; to output the full path to where the module's source code is stored. , which causes &kdesrc-build; to output the full path to where the module build process occurs. , which causes &kdesrc-build; to output the full path to where the module will be installed. , which causes &kdesrc-build; to output the location of the module within the hierarchy of KDE source code repositories. See for more information on this hierarchy. , which causes &kdesrc-build; to output the resolved git branch that will be used for each module, based on the tag, branch and branch-group settings in effect. Otherwise, option names that are valid for modules in the configuration file can be used, the resolved value of which will be listed for each module. If a single module is passed on the command line, then the output is simply the value of the parameter being queried. If multiple (or no) modules are passed on the command line, then each line is prefixed by the name of the module. Either way, &kdesrc-build; stops running once each value is output. This option was added with &kdesrc-build; 16.05. For example, the command kdesrc-build --query branch kactivities kdepim might end up with output like: kactivities: master kdepim: master --no-rebuild-on-fail Do not try to rebuild modules that have failed building from scratch. &kdesrc-build; will never try to do this to a module that already was tried to be built from scratch. --refresh-build Recreate the build system and make from scratch. --reconfigure Run cmake (for &kde; modules) or configure (for &Qt;) again, without cleaning the build directory. You should not normally have to specify this, as &kdesrc-build; will detect when you change the relevant options and automatically re-run the build setup. This option is implied if --refresh-build is used. --resume-from This option is used to resume the build starting from the given module, which should be the next option on the command line. You should not specify other module names on the command line. This option formerly added --no-src, but does not any longer (since &kdesrc-build; 1.13). If you want to avoid source updates when resuming, simply pass in addition to the other options. See also: and . You would prefer to use this command line option if you have fixed the build error and want &kdesrc-build; to complete the build. --resume-after This option is used to resume the build starting after the given module, which should be the next option on the command line. You should not specify other module names on the command line. This option formerly added --no-src, but does not any longer (since &kdesrc-build; 1.13). If you want to avoid source updates when resuming, simply pass in addition to the other options. See also: and . You would prefer to use this command line option if you have fixed the build error and have also built and installed the module yourself, and want &kdesrc-build; to start again with the next module. --resume This option can be used to run &kdesrc-build; after it has had a build failure. It resumes the build from the module that failed, using the list of modules that were waiting to be built before, and disables source and metadata updates as well. The use case is when a simple mistake or missing dependency causes the build failure. Once you correct the error you can quickly get back into building the modules you were building before, without fiddling with and . This is even handier with the command line argument, especially if you're initially setting up your development environment. This option was added with &kdesrc-build; 1.16. --stop-before This command line option is used to stop the normal build process just before a module would ordinarily be built. For example, if the normal build list was moduleAmoduleBmoduleC, then would cause &kdesrc-build; to only build moduleA. This command line option was added with &kdesrc-build; 1.16. --stop-after This command line option is used to stop the normal build process just after a module would ordinarily be built. For example, if the normal build list was moduleAmoduleBmoduleC, then would cause &kdesrc-build; to build moduleA and moduleB. This command line option was added with &kdesrc-build; 1.16. --stop-on-failure This option causes the build to abort as soon as a failure occurs. Useful when you're setting up your initial development environment. Without this flag, &kdesrc-build; will try to press on with the rest of the modules in the build to avoid wasting time in case the problem is with a single module. This option was added with &kdesrc-build; 1.16. See also the stop-on-failure option. --rc-file This interprets the next command line parameter as the file to read the configuration options from. The default value for this parameter is kdesrc-buildrc (checked in the current directory) if it is present, or ~/.kdesrc-buildrc otherwise. See also . --print-modules Takes all actions up to and including dependency reordering of the modules specified on the command line (or configuration file), prints the modules that would be processed one per line, and then exits without further action. The kde-project metadata is downloaded first (though, see or ). The output is not fully compatible with usage by scripts as other output messages may be generated until the module list is shown. This is mostly just useful for quickly determining what &kdesrc-build; understands a module's dependencies to be, which means it's only useful for kde-projects modules. This option is also compatible with , , , . --list-build Lists the modules that would be built, in the order in which they would be built. If applicable, the output listing also mentions which commit/branch/tag would be selected for checkout. This option is similar to . For more detailed information on how modules relate to each other, see also: . --dependency-tree Prints out dependency information on the modules that would be built using a tree format (recursive). Listed information also includes which specific commit/branch/tag is depended on and whether or not the dependency would be built. Note: the generated output may become quite large for applications with many dependencies. --run This option interprets the next item on the command line as a program to run, and &kdesrc-build; will then finish reading the configuration file, update the environment as normal, and then execute the given program. This will not work to start a shell with the &kdesrc-build; environment in most cases however, since interactive shells typically reset at least part of the environment variables (such as PATH and KDEDIRS) in the startup sequence. If you want to see the environment used by &kdesrc-build;, you can run the printenv command: $ kdesrc-build --run printenv KDE_SESSION_VERSION=4 SDL_AUDIODRIVER=alsa LANGUAGE= XCURSOR_THEME=Oxygen_Blue LESS=-R -M --shift 5 QMAIL_CONTROLDIR=/var/qmail/control ... etc. --prefix=</path/to/kde> This allows you to change the directory that &kde; will be installed to from the command line. This option implies --reconfigure, but using --refresh-build may still be required. --revision This option causes &kdesrc-build; to checkout a specific numbered revision for each &subversion; module, overriding any branch, tag, or revision options already set for these modules. This option is likely not a good idea, and is only supported for compatibility with older scripts. --build-system-only This option causes &kdesrc-build; to abort building a module just before the make command would have been run. This is supported for compatibility with older versions only, this effect is not helpful for the current &kde; build system. --install If this is the only command-line option, it tries to install all of the modules contained in log/latest/build-status. If command-line options are specified after --install, they are all assumed to be modules to install (even if they did not successfully build on the last run). --no-snapshots Supplying this option causes &kdesrc-build; to always perform a normal initial checkout of a module instead of using a quick-start snapshot (only available for Git modules from the kde-projects repository). Note that this option should only be used if there is a failure using snapshots, as the quick-start snapshot reduces load on the KDE source repositories. Module snapshots are real checkouts. You should not need to specify this option, it is only a troubleshooting aid. --delete-my-patches This option is used to let &kdesrc-build; delete source directories that may contain user data, so that the module can be re-downloaded. This would normally only be useful for &kde; developers (who might have local changes that would be deleted). This is currently only used to checkout modules that have been converted from &subversion; to &git;. You should not use this option normally, &kdesrc-build; will prompt to be re-run with it if it is needed. --delete-my-settings This option is used to let &kdesrc-build; overwrite existing files which may contain user data. This is currently only used for xsession setup for the login manager. You should not use this option normally, &kdesrc-build; will prompt to be re-run with it if it is needed. --<option-name>= You can use this option to override an option in your configuration file for every module. For instance, to override the log-dir option, you would do: --log-dir=/path/to/dir. This feature can only be used for option names already recognized by &kdesrc-build;, that are not already supported by relevant command line options. For example the async configuration file option has specific --async and --no-async command line options that are preferred by &kdesrc-build;. --set-module-option-value=<module-name>,<option-name>,<option-value> You can use this option to override an option in your configuration file for a specific module. Any other command-line options are assumed to be modules to update and build. Please, do not mix building with installing. Using &kdesrc-build; Preface Normally using &kdesrc-build; after you have gone through is as easy as doing the following from a terminal prompt: % kdesrc-build &kdesrc-build; will then download the sources for &kde;, try to configure and build them, and then install them. Read on to discover how &kdesrc-build; does this, and what else you can do with this tool. Basic &kdesrc-build; features qt support &kdesrc-build; supports building the &Qt; toolkit used by &kde; software as a convenience to users. This support is handled by a special module named qt. &Qt; is developed under a separate repository from &kde; software located at http://code.qt.io/cgit/qt/. In order to build &Qt;, you should make sure that the qtdir setting is set to the directory you'd like to install &Qt; to, as described in . You should then ensure that the qt module is added to your .kdesrc-buildrc, before any other modules in the file. If you are using the sample configuration file, you can simply uncomment the existing qt module entry. Now you should verify the repository option and branch options are set appropriately: The first option is to build &Qt; using a mirror maintained on the &kde; source repositories (no other changes are applied, it is simply a clone of the official source). This is highly recommended due to occasional issues with cloning the full &Qt; module from its official repository. You can set the option for the qt module to kde:qt to use this option. Otherwise, to build the standard &Qt;, set your option to git://gitorious.org/qt/qt.git. Note that you may experience problems performing the initial clone of &Qt; from this repository. In both cases, the branch option should be set to master (unless you'd like to build a different branch). Standard flags added by &kdesrc-build; Nota Bene: this section does not apply to modules for which you have configured a custom toolchain, using e.g. cmake-toolchain. To save you time, &kdesrc-build; adds some standard paths to your environment for you: The path to the &kde; and &Qt; libraries is added to the LD_LIBRARY_PATH variable automatically. This means that you do not need to edit &libpath; to include them. The path to the &kde; and &Qt; development support programs are added to the PATH variable automatically. This means that you do not need to edit &binpath; to include them. The path to the &kde;-provided pkg-config is added automatically to PKG_CONFIG_PATH. This means that you do not need to use &set-env; to add these. The setting for &kdedir; is automatically propagated to the KDEDIR environment variable while building. (KDEDIRS is not affected). The setting for &qtdir; is automatically propagated to the QTDIR environment variable while building. Changing &kdesrc-build;'s build priority Programs can run with different priority levels on Operating Systems, including &Linux; and &BSD;. This allows the system to allocate time for the different programs in accordance with how important they are. &kdesrc-build; will normally allocate itself a low priority so that the rest of the programs on your system are unaffected and can run normally. Using this technique, &kdesrc-build; will use extra CPU when it is available. &kdesrc-build; will still maintain a high enough priority level so that it runs before routine batch processes and before CPU donation programs such as Seti@Home. To alter &kdesrc-build; so that it uses a higher (or lower) priority level permanently, then you need to adjust the &niceness; setting in the configuration file. The &niceness; setting controls how nice &kdesrc-build; is to other programs. In other words, having a higher &niceness; gives &kdesrc-build; a lower priority. So to give &kdesrc-build; a higher priority, reduce the &niceness; (and vice versa). The &niceness; can go from 0 (not nice at all, highest priority) to 20 (super nice, lowest priority). You can also temporarily change the priority for &kdesrc-build; by using the &cmd-nice; command line option. The value to the option is used exactly the same as for &niceness;. It is possible for some programs run by the super user to have a negative nice value, with a correspondingly even higher priority for such programs. Setting a negative (or even 0) &niceness; for &kdesrc-build; is not a great idea, as it will not help run time significantly, but will make your computer seem very sluggish should you still need to use it. To run &kdesrc-build; with a niceness of 15 (a lower priority than normal): % kdesrc-build Or, you can edit the configuration file to make the change permanent: &niceness; 15 The niceness option only affects the usage of the computer's processor(s). One other major affect on computer performance relates to how much data input or output (I/O) a program uses. In order to control how much I/O a program can use, modern &Linux; operating systems support a similar tool called ionice. &kdesrc-build; supports ionice, (but only to enable or disable it completely) using the use-idle-io-priority option, since &kdesrc-build; version 1.12. Installation as the superuser You may wish to have &kdesrc-build; run the installation with super user privileges. This may be for the unrecommended system-wide installation. This is also useful when using a recommended single user &kde; build, however. This is because some modules (especially kdebase) install programs that will briefly need elevated permissions when run. They are not able to achieve these permission levels unless they are installed with the elevated permissions. You could simply run &kdesrc-build; as the super user directly, but this is not recommended, since the program has not been audited for that kind of use. Although it should be safe to run the program in this fashion, it is better to avoid running as the super user when possible. To take care of this, &kdesrc-build; provides the &make-install-prefix; option. You can use this option to specify a command to use to perform the installation as another user. The recommended way to use this command is with the &sudo; program, which will run the install command as the super user. For example, to install all modules using &sudo;, you could do something like this: global &make-install-prefix; sudo # Other options end global To use &make-install-prefix; for only a single module, this would work: module svn-module-name &make-install-prefix; sudo end module Showing the progress of a module build This feature is always available, and is automatically enabled when possible. What this does is display an estimated build progress while building a module; that way you know about how much longer it will take to build a module. Advanced features Partially building a module It is possible to build only pieces from a single &kde; module. For example, you may want to compile only one program from a module. &kdesrc-build; has features to make this easy. There are several complementing ways to do this. Checking out portions of a module This is perhaps the best way to do this. When it works, it will save you download time and disk space. What happens is that &kdesrc-build; will download only the parts of a module that you specify. This is done using the &checkout-only; option for a module, which will specify a list of directories to download. If you do not already know what to download from a module, it may be a good idea to browse the &subversion; layout for a module first, using WebSVN. To only grab &kuser; and KSystemLog from kdeadmin, you could use &checkout-only; like this: module kdeadmin &checkout-only; kuser ksystemlog end module The directories will be built in the order they are listed in the option. If one of the directories needs something else from the module to compile, then you need to make sure they are both in the &checkout-only; line, and that the required dependency goes before the directory that needs it. Also, sometimes an application may need other directories and it is hard to figure out what they are, which may require some trial and error of constantly adding directories to the option to figure out. This option depends on support from the build system of the module, so it is only useful for modules that are collections of individual applications. One final note to make about this option: If you change the value of this option, you should use kdesrc-build in order to ensure that the module is reconfigured properly. In addition, &kdesrc-build; will never remove existing files if you take away the number of directories from your &checkout-only; option, or add the option to a module that has already been checked out. Removing directories from a build Instead of restricting what is downloaded, it is possible to download everything but have the build system leave out a few directories when it does the build. This may be useful if one directory always breaks and is unnecessary to the rest of the module. This is controlled with the &do-not-compile; option. It works similar to the &checkout-only; option just described, in that it is simply a list of directories that should not be compiled. Also like &checkout-only;, this option requires at least that the build system for the module is reconfigured after changing it. This is done using the kdesrc-build command. To remove the python directory from the kdebindings build process: module kdebindings &do-not-compile; python end module This function depends on some standard conventions used in most &kde; modules. Therefore it may not work for all programs. Branching and tagging support for &kdesrc-build; What are branches and tags? &subversion; supports managing the history of the &kde; source code. &kde; uses this support to create branches for development, and to tag the repository every so often with a new version release. For example, the &kmail; developers may be working on a new feature in a different branch in order to avoid breaking the version being used by most developers. This branch has development ongoing inside it, even while the main branch (called /trunk) may have development going on inside of it. A tag, on the other hand, is a snapshot of the source code repository at a position in time. This is used by the &kde; administration team to mark off a version of code suitable for release and still allow the developers to work on the code. In &subversion;, there is no difference between branches, tags, or trunk within the code. It is only a convention used by the developers. This makes it difficult to properly support branches and tags within &kdesrc-build;. However, there are some things that can be done. How to use branches and tags Support for branches and tags is handled by a set of options, which range from a generic request for a version, to a specific &url; to download for advanced users. The easiest method is to use the &branch; and &tag; options. You simply use the option along with the name of the desired branch or tag for a module, and &kdesrc-build; will try to determine the appropriate location within the &kde; repository to download from. For most &kde; modules this works very well. To download kdelibs from &kde; 4.6 (which is simply known as the 4.6 branch): module kdelibs branch 4.6 # other options... end module Or, to download kdemultimedia as it was released with &kde; 4.6.1: module kdemultimedia tag 4.6.1 # other options... end module You can specify a global branch value. But if you do so, do not forget to specify a different branch for modules that should not use the global branch! Advanced branch support options &kdesrc-build; supports two options for situations where &branch; and &tag; guess the correct path improperly: &module-base-path; and &override-url;. &module-base-path; is used to help &kdesrc-build; fill in the missing part of a module's path. In the &kde; repository, all of the paths are of the form svnRoot/module-base-path/module-name. Normally &kdesrc-build; can figure out the appropriate middle part by itself. When it cannot, you can use &module-base-path;, like this: module kdesupport # kdesupport supports various tags to easily organize the required # software for a given KDE Platform release. module-base-path tags/kdesupport-for-4.5 end module This would cause &kdesrc-build; to download kdesupport from (in this example), svn://anonsvn.kde.org/home/kde/tags/kdesupport-for-4.5. In previous versions of &kdesrc-build;, the &module-base-path; was handled differently. If you encounter trouble using an old module-base-path definition perhaps you should verify that the actual path is as &kdesrc-build; expects by using the --pretend option. The &override-url; option, on the other hand, requires you to specify the exact path to download from. However, this allows you to pull from paths that previous versions of &kdesrc-build; would have no hope of downloading from. Currently, the &module-base-path; option should be sufficient for any Subversion source URL. &kdesrc-build; will not touch or correct the value you specify for &override-url; at all, so if you change your &svn-server; setting, you may need to update this as well. How &kdesrc-build; tries to ensure a successful build Automatic rebuilds &kdesrc-build; used to include features to automatically attempt to rebuild the module after a failure (as sometimes this re-attempt would work, due to bugs in the build system at that time). Thanks to switching to &cmake; the build system no longer suffers from these bugs, and so &kdesrc-build; will not try to build a module more than once. There are situations where &kdesrc-build; will automatically take action though: If you change configure-flags or cmake-options for a module, then &kdesrc-build; will detect that and automatically re-run configure or cmake for that module. If the buildsystem does not exist (even if &kdesrc-build; did not delete it) then &kdesrc-build; will automatically re-create it. This is useful to allow for performing a full --refresh-build for a specific module without having that performed on other modules. Manually rebuilding a module If you make a change to a module's option settings, or the module's source code changes in a way &kdesrc-build; does not recognize, you may need to manually rebuild the module. You can do this by simply running kdesrc-build . If you would like to have &kdesrc-build; automatically rebuild the module during the next normal build update instead, you can create a special file. Every module has a build directory. If you create a file called .refresh-me in the build directory for a module, &kdesrc-build; will rebuild the module next time the build process occurs, even if it would normally perform the faster incremental build. By default, the build directory is ~/kdesrc/build/module/. If you change the setting of the &build-dir; option, then use that instead of ~/kdesrc/build. Rebuild using .refresh-me for module kdelibs: % touch ~/kdesrc/build/kdelibs/.refresh-me % kdesrc-build Changing environment variable settings Normally &kdesrc-build; uses the environment that is present when starting up when running programs to perform updates and builds. This is useful for when you are running &kdesrc-build; from the command line. However, you may want to change the setting for environment variables that &kdesrc-build; does not provide an option for directly. (For instance, to setup any required environment variables when running &kdesrc-build; on a timer such as &cron;) This is possible with the &set-env; option. Unlike most options, it can be set more than once, and it accepts two entries, separated by a space. The first one is the name of the environment variable to set, and the remainder of the line is the value. Set DISTRO=BSD for all modules: global set-env DISTRO BSD end global Resuming builds Resuming a failed or canceled build You can tell &kdesrc-build; to start building from a different module than it normally would. This can be useful when a set of modules failed, or if you canceled a build run in the middle. You can control this using the &cmd-resume-from; option and the &cmd-resume-after; option. Older versions of &kdesrc-build; would skip the source update when resuming a build. This is no longer done by default, but you can always use the command line option to skip the source update. Resuming the build starting from kdebase: % kdesrc-build Resuming the build starting after kdebase (in case you manually fixed the issue and installed the module yourself): % kdesrc-build If the last &kdesrc-build; build ended with a build failure, you can also use the --resume command line option, which resumes the last build starting at the module that failed. The source and metadata updates are skipped as well (but if you need these, it's generally better to use --resume-from instead). Ignoring modules in a build Similar to the way you can resume the build from a module, you can instead choose to update and build everything normally, but ignore a set of modules. You can do this using the &cmd-ignore-modules; option. This option tells &kdesrc-build; to ignore all the modules on the command line when performing the update and build. Ignoring extragear/multimedia and kdereview during a full run: % kdesrc-build extragear/multimedia kdereview Changing options from the command line Changing global options You can change the setting of options read from the configuration file directly from the command line. This change will override the configuration file setting, but is only temporary. It only takes effect as long as it is still present on the command line. &kdesrc-build; allows you to change options named like option-name by passing an argument on the command line in the form . &kdesrc-build; will recognize whether it does not know what the option is, and search for the name in its list of option names. If it does not recognize the name, it will warn you, otherwise it will remember the value you set it to and override any setting from the configuration file. Setting the &source-dir; option to /dev/null for testing: % kdesrc-build Changing module options It is also possible to change options only for a specific module. The syntax is similar: --module,option-name=value. This change overrides any duplicate setting for the module found in the configuration file, and applies only while the option is passed on the command line. Using a different build directory for the kdeedu module: % kdesrc-build Features for &kde; developers &ssh; Agent checks &kdesrc-build; can ensure that &kde; developers that use &ssh; to access the &kde; source repository do not accidentally forget to leave the &ssh; Agent tool enabled. This can cause &kdesrc-build; to hang indefinitely waiting for the developer to type in their &ssh; password, so by default &kdesrc-build; will check if the Agent is running before performing source updates. This is only done for &kde; developers using &ssh;. This is because no password is required for the default anonymous checkout. &subversion; will handle passwords for the second possible protocol for &kde; developers, https. You may wish to disable the &ssh; Agent check, in case of situations where &kdesrc-build; is mis-detecting the presence of an agent. To disable the agent check, set the option to true. Disabling the &ssh; agent check: global disable-agent-check true end global Other &kdesrc-build; features Changing the amount of output from &kdesrc-build; &kdesrc-build; has several options to control the amount of output the script generates. In any case, errors will always be output. The option (short form is ) causes &kdesrc-build; to be mostly silent. Only important messages, warnings, or errors will be shown. When available, build progress information is still shown. The option (no short form) causes &kdesrc-build; to only display important warnings or errors while it is running. The option (short form is ) causes &kdesrc-build; to be very detailed in its output. The option is for debugging purposes only, it causes &kdesrc-build; to act as if was turned on, causes commands to also output to the terminal, and will display debugging information for many functions. Color output When being run from &konsole; or a different terminal, &kdesrc-build; will normally display with colorized text. You can disable this by using the on the command line, or by setting the &colorful-output; option in the configuration file to false. Disabling color output in the configuration file: global colorful-output false end global Removing unneeded directories after a build Are you short on disk space but still want to run a bleeding-edge &kde; checkout? &kdesrc-build; can help reduce your disk usage when building &kde; from &subversion;. Be aware that building &kde; does take a lot of space. There are several major space-using pieces when using &kdesrc-build;: The actual source checkout can take up a fair amount of space. The default modules take up about 1.6 gigabytes of on-disk space. You can reduce this amount by making sure that you are only building as many modules as you actually want. &kdesrc-build; will not delete source code from disk even if you delete the entry from the configuration file, so make sure that you go and delete unused source checkouts from the source directory. Note that the source files are downloaded from the Internet, you should not delete them if you are actually using them, at least until you are done using &kdesrc-build;. Also, if you already have a &Qt; installed by your distribution (and the odds are good that you do), you probably do not need to install the qt module. That will shave about 200 megabytes off of the on-disk source size. One thing to note is that due to the way &subversion; works: there are actually two files on disk for every file checked-out from the repository. &kdesrc-build; does not have code at this point to try and minimize the source size when the source is not being used. &kdesrc-build; will create a separate build directory to build the source code in. Sometimes &kdesrc-build; will have to copy a source directory to create a fake build directory. When this happens, space-saving symlinks are used, so this should not be a hassle on disk space. The build directory will typically be much larger than the source directory for a module. For example, the build directory for kdebase is about 1050 megabytes, whereas kdebase's source is only around 550 megabytes. Luckily, the build directory is not required after a module has successfully been built and installed. &kdesrc-build; can automatically remove the build directory after installing a module, see the examples below for more information. Note that taking this step will make it impossible for &kdesrc-build; to perform the time-saving incremental builds. Finally, there is disk space required for the actual installation of &kde;, which does not run from the build directory. This typically takes less space than the build directory. It is harder to get exact figures however. How do you reduce the space requirements of &kde;? One way is to use the proper compiler flags, to optimize for space reduction instead of for speed. Another way, which can have a large effect, is to remove debugging information from your &kde; build. You should be very sure you know what you are doing before deciding to remove debugging information. Running bleeding-edge software means you are running software which is potentially much more likely to crash than a stable release. If you are running software without debugging information, it can be very hard to create a good bug report to get your bug resolved, and you will likely have to re-enable debugging information for the affected application and rebuild to help a developer fix the crash. So, remove debugging information at your own risk! Removing the build directory after installation of a module. The source directory is still kept, and debugging is enabled: global configure-flags --enable-debug remove-after-install builddir # Remove build directory after install end global Removing the build directory after installation, without debugging information, with size optimization. global cxxflags -Os # Optimize for size configure-flags --disable-debug remove-after-install builddir # Remove build directory after install end global &cmake;, the &kde; build system Introduction to &cmake; In March 2006, the &cmake; program beat out several competitors and was selected to be the build system for &kde; 4, replacing the autotools-based system that &kde; had used from the beginning. A introduction to &cmake; page is available on the &kde; Community Wiki. Basically, instead of running make Makefile.cvs, then configure, then &make;, we simply run &cmake; and then &make;. &kdesrc-build; has support for &cmake;. A few features of &kdesrc-build; were really features of the underlying buildsystem, including configure-flags and do-not-compile. When equivalent features are available, they are provided. For instance, the equivalent to the configure-flags option is cmake-options, and the do-not-compile option is also supported for &cmake; as of &kdesrc-build; version 1.6.3. Credits And License &underFDL; &kde; modules and source code organization The <quote>Module</quote> &kde; groups its software into modules of various size. This was initially a loose grouping of a few large modules, but with the introduction of the Git-based source code repositories, these large modules were further split into many smaller modules. &kdesrc-build; uses this module concept as well. In essence, a module is a grouping of code that can be downloaded, built, tested, and installed. Individual modules It is easy to set &kdesrc-build; to build a single module. The following listing is an example of what a declaration for a Subversion-based module would look like in the configuration file. module kdefoo end module This is a Subversion-based module since it doesn't use a repository option. Also, the option is listed as an example only, it is not required. Groups of related modules Now most &kde; source modules are Git-based &kde;, and are normally combined into groups of modules. &kdesrc-build; therefore supports groups of modules as well, using module sets. An example: module-set base-modules kde-projects kde-runtime kde-workspace kde-baseapps end module-set You can leave the module set name (base-modules in this case) empty if you like. This setting tells &kdesrc-build; where to download the source from, but you can also use a git:// URL. One special feature of the kde-projects is that &kdesrc-build; will automatically include any Git modules that are grouped under the modules you list (in the KDE Project database). Module <quote>branch groups</quote> Taking the concept of a group of modules further, the &kde; developers eventually found that synchronizing the names of the Git branches across a large number of repositories was getting difficult, especially during the development push for the new &kde; Frameworks for &Qt; 5. So the concept of branch groups was developed, to allow users and developers to select one of only a few groups, and allow the script to automatically select the appropriate Git branch. &kdesrc-build; supports this feature as of version 1.16-pre2, via the branch-group option. Example of using branch-group branch-group can be used in the configuration file as follows: global # Select KDE Frameworks 5 and other Qt5-based apps kf5-qt5 # Other global options here ... end global module-set # branch-group only works for kde-projects kde-projects # branch-group is inherited from the one set globally, but could # specified here. kdelibs kde-workspace end module-set # kdelibs's branch will be "frameworks" # kde-workspace's branch will be "master" (as of August 2013) In this case the same branch-group gives different branch names for each Git module. This feature requires some data maintained by the &kde; developers in a Git repository named kde-build-metadata, however this module will be included automatically by &kdesrc-build; (though you may see it appear in the script output). &kde; modules that do not have a set branch name for the branch group you choose will default to an appropriate branch name, as if you had not specified branch-group at all. Superseded profile setup procedures Setting up a &kde; login profile These instructions cover how to setup the profile required to ensure your computer can login to your newly-built &kde; &plasma; desktop. &kdesrc-build; will normally try to do this automatically (see ). This appendix section can be useful for those who cannot use &kdesrc-build;'s support for login profile setup. However the instructions may not always be up-to-date, it can also be useful to consult the kde-env-master.sh file included with the &kdesrc-build; source. Changing your startup profile settings The .bash_profile is the login settings file for the popular bash shell used by many &Linux; distributions. If you use a different shell, then you may need to adjust the samples given in this section for your particular shell. Open or create the .bash_profile file in the home directory with your favorite editor, and add to the end of the file: If you are building the qt module (you are by default), add instead: QTDIR=(path to qtdir) # Such as ~/kdesrc/build/qt by default. KDEDIR=(path to kdedir) # Such as ~/kde by default. KDEDIRS=$KDEDIR PATH=$KDEDIR/bin:$QTDIR/bin:$PATH MANPATH=$QTDIR/doc/man:$MANPATH # Act appropriately if LD_LIBRARY_PATH is not already set. if [ -z $LD_LIBRARY_PATH ]; then LD_LIBRARY_PATH=$KDEDIR/lib:$QTDIR/lib else LD_LIBRARY_PATH=$KDEDIR/lib:$QTDIR/lib:$LD_LIBRARY_PATH fi export QTDIR KDEDIRS PATH MANPATH LD_LIBRARY_PATH or, if you are not building qt (and are using your system &Qt; instead), add this instead: KDEDIR=(path to kdedir) # Such as ~/kde by default. KDEDIRS=$KDEDIR PATH=$KDEDIR/bin:$QTDIR/bin:$PATH # Act appropriately if LD_LIBRARY_PATH is not already set. if [ -z $LD_LIBRARY_PATH ]; then LD_LIBRARY_PATH=$KDEDIR/lib else LD_LIBRARY_PATH=$KDEDIR/lib:$LD_LIBRARY_PATH fi export KDEDIRS PATH LD_LIBRARY_PATH If you are not using a dedicated user, set a different $KDEHOME for your new environment in your .bash_profile: export KDEHOME="${HOME}/.kde-svn" # Create it if needed [ ! -e ~/.kde-svn ] && mkdir ~/.kde-svn If later your K Menu is empty or too crowded with applications from your distribution, you may have to set the XDG environment variables in your .bash_profile: XDG_CONFIG_DIRS="/etc/xdg" XDG_DATA_DIRS="${KDEDIR}/share:/usr/share" export XDG_CONFIG_DIRS XDG_DATA_DIRS Starting &kde; Now that you have adjusted your environment settings to use the correct &kde;, it is important to ensure that the correct startkde script is used as well. Open the .xinitrc text file from the home directory, or create it if necessary. Add the line: exec On some distributions, it may be necessary to perform the same steps with the .xsession file, also in the home directory. This is especially true when using graphical login managers such as &kdm;, gdm, or xdm. Now start your fresh &kde;: in &BSD; and &Linux; systems with virtual terminal support, &Ctrl;&Alt;F1 ... &Ctrl;&Alt;F12 keystroke combinations are used to switch to Virtual Console 1 through 12. This allows you to run more than one desktop environment at the same time. The fist six are text terminals and the following six are graphical displays. If when you start your computer you are presented to the graphical display manager instead, you can use the new &kde; environment, even if it is not listed as an option. Most display managers, including &kdm;, have an option to use a Custom Session when you login. With this option, your session settings are loaded from the .xsession file in your home directory. If you have already modified this file as described above, this option should load you into your new &kde; installation. If it does not, there is something else you can try that should normally work: Press &Ctrl;&Alt;F2, and you will be presented to a text terminal. Log in using the dedicated user and type: startx You can run the &kde; from sources and the old &kde; at the same time! Log in using your regular user, start the stable &kde; desktop. Press &Ctrl;&Alt;F2 (or F1, F3, etc..), and you will be presented with a text terminal. Log in using the dedicated &kde; &subversion; user and type: startx You can go back to the &kde; desktop of your regular user by pressing the shortcut key for the already running desktop. This is normally &Ctrl;&Alt;F7, you may need to use F6 or F8 instead. To return to your &kdesrc-build;-compiled &kde;, you would use the same sequence, except with the next function key. For example, if you needed to enter &Ctrl;&Alt;F7 to switch to your regular &kde;, you would need to enter &Ctrl;&Alt;F8 to go back to your &kdesrc-build; &kde;. diff --git a/modules/ksb/BuildException.pm b/modules/ksb/BuildException.pm index be4d6ff..cd67890 100644 --- a/modules/ksb/BuildException.pm +++ b/modules/ksb/BuildException.pm @@ -1,153 +1,153 @@ package ksb::BuildException 0.20; # A class to wrap 'exception' messages for the script, allowing them to be # dispatch based on type and automatically stringified. use 5.014; # Needed for state keyword use strict; use warnings; use Carp; use overload '""' => \&to_string; use Exporter qw(import); our @EXPORT = qw(croak_runtime croak_internal had_an_exception make_exception); sub new { my ($class, $type, $msg) = @_; return bless({ 'exception_type' => $type, 'message' => $msg, }, $class); } sub to_string { my $exception = shift; return $exception->{exception_type} . " Error: " . $exception->{message}; } sub message { my $self = shift; return $self->{message}; } sub setMessage { my ($self, $newMessage) = @_; $self->{message} = $newMessage; } # # Exported utility functions # # Returns a Perl exception object to pass to 'die' function # The returned reference will be an instance of ksb::BuildException. # # First parameter: Exception type, 'Exception' if undef # Second parameter: Message to show to user sub make_exception { my $exception_type = shift // 'Exception'; my $message = shift; my $levels = shift // 0; # Allow for more levels to be removed from bt # Remove this subroutine from the backtrace local $Carp::CarpLevel = 1 + $levels; $message = Carp::cluck($message) if $exception_type eq 'Internal'; return ksb::BuildException->new($exception_type, $message); } # Helper function to return $@ if $@ is a ksb::BuildException. # # This function assumes that an eval block had just been used in order to set # or clear $@ as appropriate. sub had_an_exception { if ($@ && ref $@ && $@->isa('ksb::BuildException')) { return $@; } return; } # Should be used for "runtime errors" (i.e. unrecoverable runtime problems that # don't indicate a bug in the program itself). sub croak_runtime { die (make_exception('Runtime', $_[0], 1)); } # Should be used for "logic errors" (i.e. impossibilities in program state, things # that shouldn't be possible no matter what input is fed at runtime) sub croak_internal { die (make_exception('Internal', $_[0], 1)); } # # A small subclass to hold the option name that caused a config exception to # be thrown. # # Typically this will be caught by config-reading code in ksb::Application, # which will add filename and line number information to the message. # package ksb::BuildException::Config 0.10 { use parent qw(ksb::BuildException); use Scalar::Util qw(blessed); sub new { my ($class, $bad_option_name, $msg) = @_; my $self = ksb::BuildException->new('Config', $msg); $self->{'config_invalid_option_name'} = $bad_option_name; return $self; } sub problematicOptionName { my $self = shift; return $self->{'config_invalid_option_name'}; } # Should return a lengthy explanation of how to use a given option for use in # error messages, or undef if no explanation is unavailable. sub optionUsageExplanation { my $optionName = shift; my $result; if (blessed($optionName)) { # Should only happen if called as method: ie. $optionName == $self $optionName = $optionName->problematicOptionName(); } if ($optionName eq 'git-repository-base') { $result = <<"EOF"; The y[git-repository-base] option requires a repository name and URL. -e.g. git-repository base y[b[kde] g[b[https://anongit.kde.org/] +e.g. git-repository base y[b[kde-sdk] g[b[https://invent.kde.org/sdk/] Use this in a "module-set" group: e.g. -module-set kdesupport-set - repository y[b[kde] - use-modules automoc akonadi soprano attica +module-set kdesdk-set + repository y[b[kde-sdk] + use-modules kdesrc-build kde-dev-scripts clazy end module-set EOF } return $result; } 1; }; 1;