diff --git a/.arcconfig b/.arcconfig new file mode 100644 index 0000000..3e8f834 --- /dev/null +++ b/.arcconfig @@ -0,0 +1,3 @@ +{ + "phabricator.uri" : "https://phabricator.kde.org/source/kdesrc-build/repository/master/" +} diff --git a/CMakeLists.txt b/CMakeLists.txt index 1566ec0..8ac976c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,100 +1,101 @@ cmake_minimum_required(VERSION 3.0) project(kdesrc-build) # Needed for the docs, but optional. If not found, we will simply # defer to native CMake handling. -find_package(ECM 5.10.0 NO_MODULE) +find_package(ECM 5.10.0 NO_MODULE QUIET) if (ECM_FOUND) set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${ECM_KDE_MODULE_DIR}) include(KDEInstallDirs) include(KDECMakeSettings) include(FeatureSummary) include(ECMOptionalAddSubdirectory) find_package(KF5 5.10.0 COMPONENTS DocTools) if(KF5_DocTools_FOUND) ecm_optional_add_subdirectory(doc) else() message(WARNING "Found ECM, but not KF5::DocTools; documentation will not be built") endif() else() message(WARNING "Did not find extra-cmake-modules; documentation will not be built and install paths will be guessed based on CMake settings.") # ECM now sets KDE_INSTALL_DATADIR to PREFIX/share, try to match set(KDE_INSTALL_DATADIR "${CMAKE_INSTALL_PREFIX}/share" CACHE PATH "The parent directory where applications can install their data") set(KDE_INSTALL_BINDIR "${CMAKE_INSTALL_PREFIX}/bin" CACHE PATH "The install dir for executables") endif() set(KDESRC_BUILD_INSTALL_MODULES TRUE CACHE BOOL "Controls whether to install the modules that make up the script. Leave enabled unless running straight from source") set(KDESRC_BUILD_MODULE_INSTALL_PREFIX "${KDE_INSTALL_DATADIR}/kdesrc-build/modules" CACHE PATH "Prefix to install the component Perl modules to. (This is only an option to allow for installing to vendor_perl or similar)") if (KDESRC_BUILD_INSTALL_MODULES) message(STATUS "Installing component modules to ${KDESRC_BUILD_MODULE_INSTALL_PREFIX}") install(FILES modules/ksb/Application.pm modules/ksb/BuildContext.pm modules/ksb/BuildException.pm modules/ksb/BuildSystem.pm modules/ksb/Debug.pm modules/ksb/DependencyResolver.pm + modules/ksb/FirstRun.pm modules/ksb/KDEProjectsReader.pm modules/ksb/Module.pm modules/ksb/ModuleResolver.pm modules/ksb/ModuleSet.pm modules/ksb/OptionsBase.pm modules/ksb/OSSupport.pm modules/ksb/PhaseList.pm modules/ksb/PromiseChain.pm modules/ksb/RecursiveFH.pm modules/ksb/StatusMonitor.pm modules/ksb/StatusView.pm modules/ksb/Updater.pm modules/ksb/Util.pm modules/ksb/Version.pm DESTINATION ${KDESRC_BUILD_MODULE_INSTALL_PREFIX}/ksb) install(FILES modules/ksb/BuildSystem/Autotools.pm modules/ksb/BuildSystem/CMakeBootstrap.pm modules/ksb/BuildSystem/KDE4.pm modules/ksb/BuildSystem/QMake.pm modules/ksb/BuildSystem/Qt4.pm DESTINATION ${KDESRC_BUILD_MODULE_INSTALL_PREFIX}/ksb/BuildSystem) install(FILES modules/ksb/Module/BranchGroupResolver.pm DESTINATION ${KDESRC_BUILD_MODULE_INSTALL_PREFIX}/ksb/Module) install(FILES modules/ksb/ModuleSet/KDEProjects.pm modules/ksb/ModuleSet/Null.pm DESTINATION ${KDESRC_BUILD_MODULE_INSTALL_PREFIX}/ksb/ModuleSet) install(FILES modules/ksb/Updater/Bzr.pm modules/ksb/Updater/Git.pm modules/ksb/Updater/KDEProject.pm modules/ksb/Updater/KDEProjectMetadata.pm modules/ksb/Updater/Svn.pm DESTINATION ${KDESRC_BUILD_MODULE_INSTALL_PREFIX}/ksb/Updater) endif() install(PROGRAMS ${CMAKE_CURRENT_SOURCE_DIR}/kdesrc-build DESTINATION ${KDE_INSTALL_BINDIR}) install(PROGRAMS ${CMAKE_CURRENT_SOURCE_DIR}/kdesrc-build-setup DESTINATION ${KDE_INSTALL_BINDIR}) install(PROGRAMS ${CMAKE_SOURCE_DIR}/sample-kde-env-master.sh ${CMAKE_SOURCE_DIR}/sample-xsession.sh ${CMAKE_SOURCE_DIR}/kf5-applications-build-include ${CMAKE_SOURCE_DIR}/kf5-extragear-build-include ${CMAKE_SOURCE_DIR}/kf5-frameworks-build-include ${CMAKE_SOURCE_DIR}/kf5-kdepim-build-include ${CMAKE_SOURCE_DIR}/kf5-qt5-build-include ${CMAKE_SOURCE_DIR}/kf5-workspace-build-include DESTINATION ${KDE_INSTALL_DATADIR}/kdesrc-build) if (ECM_FOUND) feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGES) endif() diff --git a/README b/README deleted file mode 100644 index bad1446..0000000 --- a/README +++ /dev/null @@ -1,120 +0,0 @@ -# kdesrc-build - -## QUICK HOWTO - -1. Install kdesrc-build: - - Copy the kdesrc-build directory (i.e. the directory holding this README) - somewhere where you will be able to find it. The whole directory has to - go together, so don't just copy the script itself. - - - Alternately, you can run the `git` command itself to easily install - kdesrc-build: - - $ mkdir -p ~/kdesrc - $ cd ~/kdesrc - $ git clone https://anongit.kde.org/kdesrc-build - $ cd kdesrc-build # kdesrc-build is in this directory - -2. Setup: - - **For KDE 4 Platform and Plasma Desktop**: If you don't already have a - ~/.kdesrc-buildrc, use the kdesrc-build-setup program to make one, or - copy kdesrc-buildrc-sample to ~/.kdesrc-buildrc and make any changes that - you need. - - - **For KDE Frameworks ("KF5") / Plasma 5**: Please take a look at - `kdesrc-build-kf5-sample` in the kdesrc-build directory, - which gives a starting point example for a suitable ~/.kdesrc-buildrc. - - - the `kdesrc-buildrc-sample` file in the kdesrc-build directory - gives a few hints at what options are available. Also, look at the - documentation at - https://docs.kde.org/trunk5/en/extragear-utils/kdesrc-build/conf-options-table.html - -3. From the kdesrc-build directory, run "./kdesrc-build --metadata-only". This - will download some data that describes the KDE source repositories and their - dependencies, which will help kdesrc-build figure out what to build. - -4. Now you can run "kdesrc-build --pretend" to have kdesrc-build go through the - steps that it would perform, but without actually doing them. This is a good - time to make sure that kdesrc-build is set the way you want it. - -5. When you're ready, run "./kdesrc-build". 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 is kept upgraded automatically. This is mostly done in the sample -configuration for KF5, where kdesrc-build is configured to update itself, -however for the best success you should remember to add the kdesrc-build git -repository to your PATH environment variable. - -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. It should work for you for the most -part with only minor tweaking. To use it, just copy it to ~/.kdesrc-buildrc. - -Alternatively, a program is included called kdesrc-build-setup, which can be -used to generate a simple configuration (for KDE4-based builds). - -## HELP!!! - -kdesrc-build includes a limited command-line description with the ---help option. - -You can read the kdesrc-build handbook online at -https://docs.kde.org/index.php?application=kdesrc-build - -If you have already setup a KDE build environment then kdesrc-build itself can -have its documentation compiled and installed. -In this case the documentation is available in Konqueror (help:/kdesrc-build) -or KHelpCenter. Additionally a man page will be installed, or you can run "man -./kdesrc-build.1" in the "doc/" directory of kdesrc-build's own build -directory. - -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) - -## UPDATES / CONTACT INFO - -You can find updated versions of kdesrc-build online as part of the -extragear/utils module: (You can also see the change log this way) - -https://projects.kde.org/projects/extragear/utils/kdesrc-build - -In fact, it is unlikely that future releases will be made. Though new versions -will be tagged, they will not be released as source tarballs. You should run -from git (it is likely a 'stable' branch will be setup to make this more -feasible) - -If you find a bug, please report it at: - https://bugs.kde.org/ - -If you have any questions, feel free to let me know: - Michael Pyne diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b3fb93 --- /dev/null +++ b/README.md @@ -0,0 +1,270 @@ +# 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. + +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 +$ 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/CMakeLists.txt b/doc/CMakeLists.txt index 065436b..a2117a6 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,6 +1,15 @@ ########### install files ############### kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kdesrc-build) kdoctools_create_manpage(man-kdesrc-build.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR}) kdoctools_create_manpage(man-kdesrc-build-setup.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR}) install(PROGRAMS kdesrc-build.desktop DESTINATION ${XDG_APPS_INSTALL_DIR}) + +# Look for asciidoctor for source reference +find_program(ASCIIDOCTOR_PATH asciidoctor) + +if (ASCIIDOCTOR_PATH) + add_subdirectory(source-reference) +else() + message(STATUS "Could not find asciidoctor, will not build developer source reference") +endif() diff --git a/doc/index.docbook b/doc/index.docbook index edece92..9ae05c3 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,4679 +1,4697 @@ 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'> 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 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 YAML::PP, YAML::XS, or YAML::Syck The Mojolicious web framework. It is small, self-contained, and allows &kdesrc-build; to support interfaces beyond the simple command-line interface while continuing to permit high performance. 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 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. &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. 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 used to control the asynchronous mode of operation, permitting source code updates to happen at the same time as the build process when possible, instead of waiting for all of the source code updates before starting the build process. Asynchronous is the only supported mode of operation, though you can still use separate --no-src and --no-build script runs to achieve the same effect. This option was available since the 1.6 release and removed late 2018. 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 This option has been removed in &kdesrc-build; 18.10, as the use cases it supported are no longer significant issues for &kde; contributors. 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. 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. This option currently only works for &cmake;-based modules. It works by passing appropriate -DBUILD_foo options when running &cmake;, but this can also be done using cmake-options. 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 updating 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 HTTP protocol used for Internet web sites. If you are using one of these constrained networks you can set this option to http to prefer HTTP 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. 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 disabled by default, to avoid inadvertently selecting a bunch of modules that were not desired. It was added with &kdesrc-build; 1.16 in 2015. 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 was removed in &kdesrc-build; 18.10 due to inability to maintain the underlying &subversion; support that is required. 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. 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. 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. 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: --help Only display simple help on this script. ---version +--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 This option used to disables the asynchronous mode of updating. Due to lack of testing and the reliability of the asynchronous mode, this option has been disabled and asynchronous builds are always in effect. --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 (or -v) +--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. --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 , , , . --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. --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; 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 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;. &cmake; options can be set for each module using cmake-options, and &kdesrc-build; will also pass required environment variable and command line options to &cmake; automatically. 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/doc/kdesrc-build.desktop b/doc/kdesrc-build.desktop index e56c4d4..8a57e2a 100644 --- a/doc/kdesrc-build.desktop +++ b/doc/kdesrc-build.desktop @@ -1,90 +1,91 @@ # KDE Config File [Desktop Entry] +Type=Application X-DocPath=kdesrc-build/index.html Name=KDE Source Builder Name[bs]=KDE graditelj izvornog koda Name[ca]=Compilació del codi font del KDE Name[ca@valencia]=Compilació del codi font del KDE Name[cs]=Sestavování KDE ze zdrojových kódů Name[da]=KDE Source Builder Name[de]=KDE-Source-Builder Name[el]=Κατασκευαστής πηγής του KDE Name[en_GB]=KDE Source Builder Name[es]=Constructor del código fuente de KDE Name[et]=KDE lähtekoodi ehitaja Name[fi]=KDE-lähdekoodin kääntämisohjelma Name[fr]=Compilateur de sources KDE Name[ga]=Tógálaí Foinse KDE Name[gl]=Compilador do código de KDE Name[hu]=KDE forrásfordító Name[it]=Generazione del sorgente di KDE Name[km]=កម្មវិធី​ស្ថាបនា​ប្រភព​​របស់​ KDE​ Name[ko]=KDE 소스 빌더 Name[lt]=KDE kodo kompiliuoklis Name[mr]=केडीई स्रोतबिल्डर Name[nb]=KDE kildebygger Name[nds]=KDE-Bornkode-Buumoduul Name[nl]=KDE Source Builder Name[nn]=Byggjar for KDE-kjeldekode Name[pa]=KDE ਸਰੋਤ ਬਿਲਡਰ Name[pl]=Budowanie KDE ze źródeł Name[pt]=Compilação do Código do KDE Name[pt_BR]=Compilação do código do KDE Name[ru]=Сборка KDE из исходного кода Name[sk]=Prekladač zdrojového kódu KDE Name[sl]=Izgrajevalnik izvorne kode za KDE Name[sr]=Градња КДЕ‑а из извора Name[sr@ijekavian]=Градња КДЕ‑а из извора Name[sr@ijekavianlatin]=Gradnja KDE‑a iz izvora Name[sr@latin]=Gradnja KDE‑a iz izvora Name[sv]=KDE-källkodsbyggare Name[tr]=KDE Kaynak Oluşturucu Name[ug]=KDE Source Builder Name[uk]=Програма для збирання KDE з початкових кодів Name[x-test]=xxKDE Source Builderxx Name[zh_CN]=KDE 源代码构建器 Name[zh_TW]=KDE Source Builder Comment=Builds the KDE Platform and associated software from its source code. A command-line only program. Comment[bs]=Gradi platformu KDE‑a i pridruženi softver iz izvornog koda. Program komandne linije. Comment[ca]=Construeix la plataforma del KDE i el programari associat des del seu codi font. Un programa que només és per a la línia d'ordres. Comment[ca@valencia]=Construeix la plataforma del KDE i el programari associat des del seu codi font. Un programa que només és per a la línia d'ordres. Comment[cs]=Sestaví ze zdrojových kódů platformu KDE a přidružený software. Nástroj pouze pro příkazovou řádku. Comment[da]=Bygger KDE Platform og tilknyttet software fra kildekode. Et program kun til kommandolinjen. Comment[de]=Erstellt KDE und dazugehörige Software aus den Quelltexten. Es ist ein reines Befehlszeilenprogramm. Comment[el]=Δημιουργεί την πλατφόρμα του KDE και το αντίστοιχο λογισμικό από τον πηγαίο κώδικα. Ένα πρόγραμμα μόνο γραμμής εντολών. Comment[en_GB]=Builds the KDE Platform and associated software from its source code. A command-line only program. Comment[es]=Construye la Plataforma KDE y el software asociado desde su código fuente. Un programa solo para la línea de órdenes. Comment[et]=KDE platvormi ja sellega seotud tarkvara ehitamine lähtekoodist. Ainult käsureal kasutatav programm. Comment[fi]=Kääntää KDE-alustan ja siihen liittyvät ohjelmistot lähdekoodista. On vain komentoriviohjelma. Comment[fr]=Construit la plate-forme KDE et les logiciels associés à partir de son code source. Uniquement un programme en ligne de commandes. Comment[gl]=Compila a plataforma KDE e o software asociado a partires do código fonte. Programa de só liña de ordes. Comment[hu]=Lefordítja a KDE platformot és a kapcsolódó szoftvereket a forráskódjukból. Kizárólag parancssoros program. Comment[it]=Genera la piattaforma di KDE e il software ad essa associato dal codice sorgente. Un programma disponibile solo dalla riga di comando. Comment[km]=ស្ថាបនា​កម្មវិធី​របស់​ KDE និង​កម្មវិធី​​ដែល​ភ្ជាប់​​ពី​កូដ​ប្រភព​របស់​វា​​ ។​ កម្មវិធី​បន្ទាត់​ពាក្យ​បញ្ជា​តែ​​​ប៉ុណ្ណោះ​ ។​ Comment[ko]=KDE 플랫폼과 소프트웨어를 원본 코드에서 빌드합니다. 명령행 전용 프로그램입니다. Comment[lt]=Kompiliuoja KDE platformą ir susijusią programinę įrangą iš išeities kodo. Tik komandinės eilutės programa. Comment[nb]=Bygger KDE-plattformen og tilordnede programmer fra kildekoden. Dette er et program med bare kommandolinje. Comment[nds]=Buut de KDE-Systemümgeven un tohören Programmen ut den Bornkode. Bloots en Konsoolprogramm. Comment[nl]=Bouwt het KDE-platform en geassocieerde software uit zijn broncode. Werkt alleen op de opdrachtregel. Comment[nn]=Byggjer KDE-plattforma og tilhøyrande programvare frå kjeldekoden. Er eit kommandolinjebasert program. Comment[pl]=Budowanie Środowiska KDE i związanego z nim oprogramowania z kodu źródłowego. Program działa tylko w linii poleceń. Comment[pt]=Compila a Plataforma do KDE e os programas associados a partir do seu código-fonte. Um programa apenas para a linha de comandos. Comment[pt_BR]=Compila a Plataforma do KDE e os programas associados a partir do seu código-fonte. Um programa apenas para a linha de comando. Comment[ru]=Собирает платформу KDE и основанное на ней программное обеспечение из исходного кода. Программа предназначена только для запуска из командной строки. Comment[sk]=Vybuduje KDE platformu a asociovaný softvér z jeho zdrojového kódu. Program iba pre príkazový riadok. Comment[sl]=Izgradi okolje KDE in povezane programe iz izvorne kode. Gre za program ukazne vrstice. Comment[sr]=Гради платформу КДЕ‑а и придружени софтвер из изворног кода. Програм командне линије. Comment[sr@ijekavian]=Гради платформу КДЕ‑а и придружени софтвер из изворног кода. Програм командне линије. Comment[sr@ijekavianlatin]=Gradi platformu KDE‑a i pridruženi softver iz izvornog koda. Program komandne linije. Comment[sr@latin]=Gradi platformu KDE‑a i pridruženi softver iz izvornog koda. Program komandne linije. Comment[sv]=Bygger KDE-plattformen och tillhörande programvara från dess källkod. Ett program som bara använder kommandoraden. Comment[tr]=KDE Platformunu ve ilişkili yazılımı kaynak kodundan derler. Sadece komt satırı olan bir uygulama. Comment[ug]=KDE سۇپىسى ۋە مۇناسىۋەتلىك يۇمشاق دېتاللارنى ئەسلى كودىدىن ھاسىل قىلىش. پەقەتلا بۇيرۇق قۇرىدا ئىشلەيدۇ. Comment[uk]=Збирає Платформу KDE і пов’язане з нею програмне забезпечення з початкових кодів. Керується за допомогою командного рядка. Comment[x-test]=xxBuilds the KDE Platform and associated software from its source code. A command-line only program.xx Comment[zh_CN]=从源代码构建 KDE 平台和相关软件。纯命令行程序。 Comment[zh_TW]=從源碼建立 KDE 平台與相關軟體。是一個只有命令列的程式。 Categories=Qt;KDE;Development; Exec=kdialog --sorry "kdesrc-build is a command-line only program. Please read the handbook at help:/kdesrc-build for more information." Terminal=true NoDisplay=true diff --git a/doc/man-kdesrc-build.1.docbook b/doc/man-kdesrc-build.1.docbook index 47713bf..c17b442 100644 --- a/doc/man-kdesrc-build.1.docbook +++ b/doc/man-kdesrc-build.1.docbook @@ -1,1233 +1,1278 @@ +kdesrc-build"> ]> kdesrc-build User's Manual MichaelPyne mpyne@kde.org Authored man page 2016-05-02 kdesrc-build 16.05 kdesrc-build 1 16.05 kdesrc-build Downloads, builds and installs &kde; software. kdesrc-build OPTIONS Module name | Module set name kdesrc-build --query VALUE TO QUERY Module name DESCRIPTION The kdesrc-build command is used in order to build &kde; software directly from its source repositories. It can download from Subversion or Git repositories, interfaces with the &kde; project database, and supports controlling which options are passed to make(1) and cmake(1). The operation of kdesrc-build is driven by a configuration file, typically ~/.kdesrc-buildrc. The module name or module set name as given on the command line should be as those names were defined in the configuration file (either in a module definition or declaration, or in a definition). In addition, it can be the name of a &kde; module listed in the &kde; project database (and you can precede the module name with + to force this). kdesrc-build is designed to be able to be completely headless (however, see ENVIRONMENT), and so typically ignores its input completely. Command output is logged instead of being shown on the kdesrc-build output. Modules are built one after the other. If a module fails to update then it is not built. kdesrc-build will not abort just because of a module failure, instead it will keep trying to update and build subsequent modules. By default, kdesrc-build will commence building a module as soon as the source code update is complete for that module, even if other updates are occurring concurrently. At the end kdesrc-build will show which modules failed to build, and where the logs were kept for that build run. OPTIONS NOTE: Some options have short forms, but the kdesrc-build option parser does not support combining short options into one at this point. (E.g. running would not be the same as ). Shows a brief synopsis and frequently-used command line options. Shows information about &kdesrc-build; and the operating system which may be useful in bug reports or when requesting help on forums or mailing lists. + + + + + + + + Performs one-time setup for users running &kdesrc-build; on common + distributions. This includes installation of known system dependencies, a + default configuration file setup, and changes to your ~/.bashrc to make the + software installed by &kdesrc-build; accessible. + + + + Operate in a "dry run" mode. No network accesses are made, no log files are created, no modules are built, and no other permanent changes to disk are made. One important exception is that if you try to build a module that comes from the &kde; project database, and the database hasn't been downloaded yet, the database will be downloaded since the pretend-mode output may change significantly based on the database results. Skips the update and build phase and immediately attempts to install the modules given. Skips the update and build phase and immediately attempts to uninstall the modules given. NOTE: This is only supported for buildsystems that supports the make uninstall command (e.g. &kde; CMake-based). Skips the source update phase. Other phases are included as normal. is a deprecated alias for this option and will be removed in a future release. Skips the metadata update phase for KDE modules. Other phases (including the source update phase) are included as normal. If you wish to avoid all network updates you should also pass . This option can be useful if you are frequently running kdesrc-build since the metadata itself does not change very often. Skips the install phase from the build. Other phases are included as normal. Skips the build phase for the build. Internally the install phase depends on the build phase completing so this is effectively equivalent to , but the semantics may change in the future (e.g. when test suites are moved into their own phase). Disables running the test suite for CMake-based modules. To be fully effective this requires re-running CMake, which can be forced by using the or options. Only performs the source update phase, does not build or install. is a deprecated alias for this option and will be removed in a future release. Forces the build process to be performed without updating source code first. In addition, installation is not performed. (Testing is still performed if applicable, but this will change in a future release) Only updates the build metadata needed for KDE modules, then exits. This is useful to allow the option to work if you've never run kdesrc-build. See also . Removes the build directory for a module before the build phase starts. This has the desired side effect of forcing kdesrc-build to re-configure the module and build it from a "pristine" state with no existing temporary or intermediate output files. Use this option if you have problems getting a module to build but realize it will take longer (possibly much longer) for the build to complete as a result. When in doubt use this option for the entire kdesrc-build run. Force CMake to be re-run, but without deleting the build directory. Usually you actually want , but if you are 100% sure your change to will not invalidate your current intermediate output then this can save some time. Interrupts the build process for each module built: The build process consists of normal setup up to and including running cmake or configure (as appropriate), but make is not run and no installation is attempted. This is mostly only useful to get things like configure --help and cmake-gui to work. Normally you want or . Use this option to skip module processing until the module foo is encountered. foo and all subsequent modules will be processed normally as if they had been specified on the command line. If you use this option because of a build failure you may want to consider using in addition to skip the resultant source update phase. This is just like , except that the module foo is not included in the list of modules to consider. You might use this if you've manually built/installed foo after fixing the build and just want to resume from there. 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 option, especially if you're initially setting up your development environment. This is similar to the flag. This option causes the module list for the given build to be truncated just before foo would normally have been built. foo is not built (but see ). This flag may be used with or . This is just like , except that the given module is included in the build. This flag may be used with or . This causes kdesrc-build to include not only the modules it would normally build (either because they were specified on the command line, or mentioned in the configuration file), but also to include known dependencies of those modules in the build. Dependencies are known to kdesrc-build based on the contents of the special kde-build-metadata git repository, which is managed for you by the script (see also the option). The KDE community keeps the dependency information in that module up to date, so if kdesrc-build appears to show the wrong dependencies then it may be due to missing or incorrect dependency information. All known dependencies will be included, which may be more than you need. Consider using the option (and similar options) to control the build list when using this option. To see just the list of modules that would be built, use or . 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. 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. Forces ALL modules that follow this option to be excluded from consideration by kdesrc-build. This might be useful if you know you want to process all modules except for specific exceptions. Use the given file, foo, for the configuration instead of ~/.kdesrc-buildrc or ./kdesrc-buildrc. The file can be empty, but must exist. Overrides the setting to be foo for this run. In addition, implies . It does not actually perform the action you would think it does (overriding the option to change where modules are installed), although by default modules are installed to the setting if is not set. Changes the CPU priority given to kdesrc-build (and all processes used by kdesrc-build e.g. make(1)). foo should be an integer number between -20 and 19. Positive values are "nicer" to the rest of the system (i.e. lower priority). Note that the possible priorities available on your system may be different than listed here, see nice(2) for more information. Note also that this only changes CPU priority, often you want to change I/O priority on systems where that is supported. There is no command-line option for I/O priority adjustment, but there is a configuration file option: (although like all options, there is a generic way to set this from the command line). Runs the program named by foo using kdesrc-build's normal build environment. All command line arguments present after this option are passed to foo as it is run. 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. , which causes kdesrc-build to output the resolved git branch that will be used for each module, based on the , and 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 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 , , , and . Enables "colorful output". (Enabled by default). Disables "colorful output". This can be made permanent by setting the option to false (or 0) in your configuration file. - + + + + + + Have kdesrc-build start the build process for a module + as soon as the source code has finished downloading. Without this option + kdesrc-build performs all source updates at once and + only then starts with the build process. This option is enabled by default. + + + + + + + + + + + + Disables asynchronous building of modules. See for + a more detailed description. Note that kdesrc-build's + output will be slightly different in this mode. + + + + + + + Increases the level of verbosity of kdesrc-build output (which is already fairly verbose!) Makes kdesrc-build less noisy. Only important messages are shown. Makes kdesrc-build even less noisy. Only warnings/errors are shown. This will fill your terminal with descriptions and debugging output, usually unintelligible, describing what kdesrc-build is doing (and thinks it should be doing). The flag is included since the output may sometimes prove useful for debugging. Normally when kdesrc-build notices that there is no source update on a module which was previously successfully installed, it does not attempt to build or install that module. You can pass this flag to disable that behavior and always run make. Normally kdesrc-build supports using source repository tarball snapshots to reduce load on &kde; infrastructure for git clones for some &kde; modules. Passing this option disables this feature. This option must be passed to allow kdesrc-build to remove conflicting source directories. Currently even this only happens when trying to clone a git-based module if an existing source directory is present. Never specify this option unless it is suggested by kdesrc-build, and only if you don't mind the source directories that are referenced being deleted and re-cloned. Any option not listed above is checked to see if it matches the list of possible configuration file options. If so, the configuration file option is temporarily set to for the duration of this run. Like above, but option is only set to for the module . This does not work for module sets yet, you must repeat this for each module you want to be affected. (Of course, you could simply edit your configuration file...) This option worked slightly differently prior to version 1.16. EXIT STATUS 0 Success 1 Normally this means some part of the update, build or install process failed, but is also used for any abnormal program end not otherwise covered below. 5 A signal was received that killed kdesrc-build, but it attempted to perform normal closedown. 8 Unknown option was passed on the command line. 99 An exception was raised that forced kdesrc-build to abort early. ENVIRONMENT HOME Used for tilde-expansion of file names, and is the default base for the source, build, and installation directories. PATH This environment variable controls the default search path for executables. You can use the configuration file option to add to this variable (e.g. for running from cron(8)). LC_* Environment variables starting with LC_ control the locale used by kdesrc-build. Although kdesrc-build is still not localizable at this point, many of the commands it uses are. kdesrc-build normally sets LC_ALL=C for commands that its must examine the output of but you can manually do this as well. If setting LC_ALL=C fixes a kdesrc-build problem please submit a bug report. SSH_AGENT_PID This environment variable is checked to see if ssh-agent(1) is running, but only if kdesrc-build determines that you are checking out a module that requires an SSH login (but you should know this as no module requires this by default). KDESRC_BUILD_USE_TTY If set, this variable forces kdesrc-build not to close its input while executing system processes. Normally kdesrc-build closes stdin since the stdout and stderr for its child processes are redirected and therefore the user would never see an input prompt anyways. KDESRC_BUILD_DUMP_CONTEXT If set, this variable prints out a description of its "build context" just after reading options and command line arguments and determining which modules to build. You pretty much never want to set this. others Many programs are used by kdesrc-build in the course of its execution, including svn(1), git(1), make(1), and cmake(1). Each of these programs may have their own response to environment variables being set. kdesrc-build will pass environment variables that are set when it is run onto these processes. You can ensure certain environment variables (e.g. CC or CXX) are set by using the configuration file option. FILES ~/.kdesrc-buildrc - Default global configuration file. ./kdesrc-buildrc - If this file (note there is no leading period (.) this time) is found in the current directory when kdesrc-build is run, this file will be used for the configuration instead of ~/.kdesrc-buildrc. ~/.kdesrc-build-data - kdesrc-build uses this file to store persistent data (such as last CMake options used, last revision successfully installed, etc.). It can be safely deleted. BUGS See https://bugs.kde.org/. Be sure to search against the kdesrc-build product. EXAMPLE $ kdesrc-build Downloads, builds and installs all modules listed in the configuration file, in the order defined therein. $ kdesrc-build Same as above, except no permanent actions are taken (specifically no log files are created, downloads performed, build processes run, etc.). EXCEPTION: If you are trying to build a module defined in the &kde; project database, and the database has not been downloaded yet, kdesrc-build will download the database since this can significantly affect the final build order. $ kdesrc-build kdebase Deletes the build directory for the kdebase module set () and then starts the build process again without updating the source code in-between. $ kdesrc-build /dev/null Forces kdesrc-build to read an empty configuration file and simulate the resultant build process. This shows what would happen by default with no configuration file, without an error message about a missing configuration file. $ kdesrc-build +kdebase/kde-baseapps Downloads, builds and installs the kde-baseapps module from the &kde; project database. Since the module name is preceded by a + it is assumed to defined in the &kde; project database even if this hasn't been specifically configured in the configuration file. The kdebase/ portion forces kdesrc-build to ignore any kde-baseapps modules that are not children of the kdebase supermodule in the project database (although it is contrived for this example). $ kdesrc-build Downloads, builds and installs all modules defined in the configuration file but overrides the cmake-options option to have the value given on the command line for this run only. Any further kdesrc-build runs will use the cmake-options given in the configuration file. SEE ALSO build-tool - A program by Michael Jansen which can build &kde; software based on included recipes. RESOURCES Main web site: https://kdesrc-build.kde.org/ Documentation: https://docs.kde.org/index.php?application=kdesrc-build Setup script: kdesrc-build-setup COPYING Copyright (C) 2003-2015 Michael Pyne. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/doc/source-reference/CMakeLists.txt b/doc/source-reference/CMakeLists.txt new file mode 100644 index 0000000..bcb2ab7 --- /dev/null +++ b/doc/source-reference/CMakeLists.txt @@ -0,0 +1,22 @@ +SET(ASCIIDOCTOR_SOURCES + index.adoc + ksb/Module.adoc + ) + +# Disable use of external resources by default in the stylesheet +SET(ASCIIDOCTOR_OPTS -a 'webfonts!') + +# The most proper way to do this is to have each *.html file individually +# depend upon its *.adoc file, but asciidoctor is quick enough to just +# re-build everything each time any of those files change. +list(TRANSFORM ASCIIDOCTOR_SOURCES + PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/" + OUTPUT_VARIABLE ABS_SRC_PATH + ) + +# Note: writes to source directory by default, not build directory! +# Use "git clean -dfx" to easily completely clean a source directory. +add_custom_target(doc-sources + COMMAND ${ASCIIDOCTOR_PATH} ${ASCIIDOCTOR_OPTS} ${ABS_SRC_PATH} + DEPENDS "${ASCIIDOCTOR_SOURCES}" + ) diff --git a/doc/source-reference/README b/doc/source-reference/README new file mode 100644 index 0000000..ed64de9 --- /dev/null +++ b/doc/source-reference/README @@ -0,0 +1,16 @@ +I'm working (again) on trying to document some of what this code actually does. + +I've really tried hard to get used to Perl's POD format but it's not happening. +NaturalDocs didn't work well either. + +I actually switched to Sphinx but it's pretty difficult to have it hyperlink to +(or even understand) Perl code, and the syntax is more annoying than I'd +expected of rST. + +So right now I'm going for AsciiDoc, using the AsciiDoctor software (since +AsciiDoc itself carries a 700MB install cost even for its minimal 'base' +release, at least on Ubuntu). + +Until I add that into the build chain for kdesrc-build, it should be as simple +as installing it (sudo apt-get install asciidoctor) and then running +"asciidoctor index.adoc ksb/*.adoc" for now. diff --git a/doc/source-reference/index.adoc b/doc/source-reference/index.adoc new file mode 100644 index 0000000..f5f2993 --- /dev/null +++ b/doc/source-reference/index.adoc @@ -0,0 +1,156 @@ += kdesrc-build documentation: +Michael Pyne +v18.12, 2018-11-22 +:webfonts!: + +kdesrc-build is intended to build KDE-based software from its source repository, although it can build +other types of software from its native source control system(s) as well. + +This documentation is intended for developers to aid in hacking on kdesrc-build itself, or porting the same concepts +to other build systems if necessary. + +== Concepts + +Some basic concepts are assumed throughout for brevity. + +=== Modules + +kdesrc-build uses the "module" as the most granular level of buildable +software. Each module has a name, unique in the list of all modules. +Each module can have a specific source control system plugin (Git, +KDE's git, Subversion, etc.) and a build system plugin (qmake, CMake, KDE's +CMake, autotools, etc.) + +=== Build Phases + +A module's build process progresses through build phases, which are often +optional. + +The normal progression is: + +. Update +. Uninstall (not normally seen) +. Build system setup and configuration +. Build +. Testsuite (if enabled) +. Install + +The update phase can happen concurrently with other modules' build/install +phases, under the theory that the build phase is usually CPU-heavy so it makes +sense to start on subsequent network (IO-heavy) updates while the build +progresses. + +=== Build Context + +To group global settings and status together that exist across individual +modules, a "build context" is used, shared across the entire application. + +Each module can refer to the global build context. + +=== Configuration file (rc-file) + +kdesrc-build uses a configuration file (usually abbreviated the `+rc-file+`) to +store: + +. The list of modules to build, and +. The dependency order in which to build modules (the order seen in the rc-file), and +. The build or configuration options to use by default or on a per-module +basis. + +The configuration file is used from `+kdesrc-buildrc+` in the current directory +when kdesrc-build is run, if the file is present. If not, the global rc-file at +`+~/.kdesrc-buildrc+` is used instead. + +=== Command line + +kdesrc-build uses the command line (seen as "cmdline" in the source and commit +logs) to override the list of modules to build (nearly always still requiring +that any modules built are visible from the rc-file). The command line is also +used to override various options (such as skipping source update phases), +control output verbosity and so on. + +In theory every option in the rc-file can be set from the cmdline, and cmdline +entries override and mask any options used by default or read from an rc-file. + +=== Module Sets + +With the adoption of git, KDE exploded to having hundreds of repositories. It +would be annoying and error-prone to try to manually update the rc-file with +the list of modules to build and the proper ordering. + +Because of this, kdesrc-build supports grouping modules into "module sets" of +modules that have common options and a common repository URL prefix, as if the +user had manually entered those modules one by one. + +NOTE: This is controlled by the `+git-repository-base+` option to set the URL +prefix, the `+repository+` option to choose one of the defined bases, and the +`+use-modules+` option to list module names. + +==== KDE module sets + +To support the KDE repositories in particular, a special module set repository +is defined, `+kde-projects+`. Use of this repository enables some extra magic +in the modules that are ultimately defined from such a module set, including +automagic dependency handling and inclusion of modules based on a virtual KDE +project structure. + +NOTE: Inclusion of modules is **separate** from dependency handling, which is +also supported! + +=== Pretend mode + +The user can pass a `+--pretend+` cmdline flag to have kdesrc-build not +actually undertake the more time or resource intensive actions, so that the +user can see what kdesrc-build would do and tweak their cmdline until it looks +correct, and then remove the --pretend flag from there. + +This significantly influences the design of the script, both in action and +output. + +=== Logs and build output + +All build commands are logged to a file (see `+log_command+` in ksb::Util). +This is both to declutter the terminal output and to enable troubleshooting +after a build failure. + +The logs are generally kept in a separate directory for each separate run of +kdesrc-build. A "latest" symlink is created for each module name, which points +to the last instance of a script run. + +If a build ends in a failure, an error.log symlink is created in the specific +log directory for that module, which points to the specific build phase output +file where the build was determined to have failed. + +Sometimes there is no log though (e.g. an internal kdesrc-build failure outside +of log_command)! + +Some users prefer to have TTY output. For now the --debug cmdline option is +useful for that, but --debug has a significant amount of other changes as well. + +== Basic flow + +For each script execution, kdesrc-build generically goes through the following +steps: + +. Read the cmdline to determine global options, list of module *selectors* +(modules are defined later) and potentially alternate rc-files to use. +. Opens the selected rc-file (chosen on cmdline or based on `+$PWD+`) and reads +in the list of modules and module-sets in the rc-file along with the options +chosen for each. +. Ensures that the KDE git repository metadata is available (containing +dependency information and the virtual project path hierarchy) +. If module selectors are available from the cmdline, creates the build list by +expanding those selectors into the appropriate modules from the rc-file. If no +selectors, uses all module sets and modules from the rc-file. + * Either mode can involve resolving dependencies for KDE-based modules. +. Forks additional children to serve as a way to perform updates and build in +separate processes so that they may proceed concurrently. Once ready, performs +these two steps concurrently: +.. Updates each module in order, and +.. Performs remaining module build steps in order (waiting for the update if + needed). +. When all update/build processes are done, displays the results to the user. + +== List of Packages + +* <> diff --git a/doc/source-reference/ksb/Module.adoc b/doc/source-reference/ksb/Module.adoc new file mode 100644 index 0000000..e4e7576 --- /dev/null +++ b/doc/source-reference/ksb/Module.adoc @@ -0,0 +1,209 @@ += ksb::Module + +== DESCRIPTION + +This is ksb::Module, one of the core classes within kdesrc-build. It represents +any single "buildable" module that kdesrc-build can manage. It acts as a common +interface to the multiple types of build systems and source control management +systems that kdesrc-build supports. + +The many options available to the user are managed using setOption/getOption +(but see also the ksb::OptionsBase class that this derives from). + +kdesrc-build manages persistent metadata for each module as well, see +{set,get}PersistentOption + +== METHODS + +The basic description of each method is listed here for ease of reference. See +the source code itself for more detail. + +=== Perl integration + +These functions are used to integrate into the Perl runtime or for use from +other Perl modules. + +* ``new``, creates a new ksb::Module, and sets any provided options. + +* ``toString``, for "stringifying" a module into a quoted string. + +* ``compare``, for sorting ksb::Modules amongst each other based on name. + +=== CONFIGURATION + +These functions are used to configure what the ksb::Module object should do, +change settings, etc. + +* ``setModuleSet``, optional, specifies the ksb::ModuleSet this module was + spawned from. + +* ``setScmType``, sets the source control plugin (git, svn, kde-projects) based + on the given scmType name. Normally auto-detection is used instead, this + permits manual setup. + +* ``buildSystemFromName``, as with ``setScmType``, used to manually set the + build system plugin. This is exposed to the user as *override-build-system*. + +* ``setBuildSystem``, like ``buildSystemFromName``, but passes the proper + ksb::BuildSystem directly. + +* ``setOption``, sets a configuration option that can be checked later using + getOption. Normally set from user input (cmdline or rc-file) but supports + ways for kdesrc-build to internally override user settings or set hidden + flags for action in later phases. Does not survive beyond the current + execution. + +* ``setPersistentOption``, sets an option to a string value that will be + read-in again on the next kdesrc-build run and can then be queried again. + +* ``unsetPersistentOption``, removes an existing persistent option. + +=== INTROSPECTION + +These functions are generally just read-only accessors of information about the +object. + +==== BASIC INFORMATION + +* ``name``, returns the module name. Only one module with a given name can be + present during a build. + +* ``buildContext``, returns the ksb::BuildContext (as set when the object + was constructed) + +* ``phases``, returns the list of execution phases (update, buildsystem, test, + etc.) that apply to this module in this execution. + +* ``moduleSet``, returns the ksb::ModuleSet that was assigned earlier as the + source set. If no module set was assigned, returns a valid (but null) set. + +==== PLUGIN HANDLERS + +* ``scm``, **autodetects** the appropriate scm plugin if not already done (or + manually set), and then returns the ksb::Updater plugin. + +* ``buildSystem``, **autodetects** the appropriate build system plugin if not + already done (or manually set) and then returns the + ksb::BuildSystem|ksb/BuildSystem.pm plugin. + +* ``scmType``, returns the **name** of the scm plugin (as determined by + scm(), which can itself cause an autodetection pass. + +* ``buildSystemType``, returns the **name** of the build system plugin (as + determined by buildSystem(), which can itself cause an autodetection pass. + +* ``currentScmRevision``, returns a string with an scm-specific revision ID. + Can be a Git-style SHA, SVN-style sequential ID, or something else entirely. + Can case an autodetection of the scm plugin. + +==== PATHS + +Various path-handling functions. These aren't always easy to tell what they do +just from the method name, sadly. + +* ``getSubdirPath``, maps a path from the rc-file (based on the option-name to + pass to getOption) to a potential absolute path (handling tilde expansion + and relative paths). Does not handle colon-separated paths. + +* ``getInstallPathComponents``, returns information about the directory the + module should be installed to. See the detailed docs for this method at its + decl, but generally you can just call fullpath today. + +* ``getSourceDir``, returns absolute base path to the source directory (not + including dest-dir, module name, or anything else specific to this module). + +* ``getLogDir``, returns the base path to use for logs for this module during + this execution. **NOTE** Different modules can have different base paths. + +* ``getLogPath``, returns the absolute filename to open() for a log file for + this module based on the given basename. Updates the 'latest' symlink, which + can trigger clean up of old log dirs after all modules are built. Only use + when you're really going to open a log file! + +* ``fullpath``, returns the absolute full path to the source or build + directory, including any module name or dest-dir accoutrement. This is the + directory you can git-clone to, cd to for build, etc. + +* ``destDir``, returns the 'dest-dir' for the module. dest-dir is effectively + just a way to modify the on-disk module name. It used to be used more heavily + to allow for having multiple build/source directories for a given CVS/SVN + module (varying by branch or tag), but even with git this value may change + for KDE-based repositories to set subdirectories that match KDE project + paths. Supports expanding '$MODULE' or '${MODULE}' sequences to what + otherwise would have been the dest-dir. + +* ``installationPath``, as labeled on the tin. Prefers the 'prefix' option but + falls back to 'kdedir' if not set. + +==== USER AND PERSISTENT OPTIONS + +* ``getOption``, returns the value of the given named option. If no such option + exists, inherits the same value from the module's build context. If no such + option exists there either, returns an empty string. Option values are used + by this function only exist during this script's execution. There is magic to + permit build jobs that run in a subprocess to feed option changes back to the + parent process. + + * accepts an option name, normally as set in the rc-file. Can also accept a + second parameter 'module', to prevent falling back to a global option. + However doing this also permits ``undef`` to be returned so you must check + whether the result is defined. + + * Options starting with '#' can only be set internally (i.e. not from rc-file + or cmdline) so this can be used as a way to tag modules with data meant not + to be user-accessible... but this should probably be factored into a + dedicated parallel option stack. + + * The combination of module-specific and global options also contains a wee + bit of magic to control things like whether option values combine + ("$global-value $module-value" style) or whether a module setting + completely masks a global setting. + +* ``getPersistentOption``, similar to ``getOption``, only without the + module/global magic and the append/mask magic, and the subprocess-support + magic. But this function can return options that have been set in a previous + kdesrc-build run. kdesrc-build uses the location of the rc-file to determine + where to look for data from prior runs. + +==== KDE-SPECIFIC HANDLERS + +* ``fullProjectPath``, returns the logical module path in the git.kde.org + infrastructure for the module, if it's defined from a kde-projects module + set. E.g. for the 'juk' module, would return 'kde/kdemultimedia/juk'. + +* ``isKDEProject``, returns true if the module was sourced from the special + ``kde-projects`` module set in the user's rc-file. In this case the module's + ``moduleSet()`` function should return a ksb::ModuleSet that is-a + ksb::ModuleSet::KDEProjects. + +=== OPERATIONS + +* ``update``, which executes the update (or pretends to do so) using the + appropriate source control system and returns a true/false value reflecting + success. Note this can also throw exceptions and future code is moving more + to this mode of error-handling. + +* ``build``, which executes the build **and** install (or pretends to in pretend + mode) using the appropriate build system and returns a true/false value + reflecting success. Can also run the testsuite as part of the build. Note + this can also throw exceptions and future code is moving more to this as the + error-handling mechanism. + +* ``setupBuildSystem``, which sets up the build system for the module to permit + ``build`` to work, including creating build dir, running cmake/configure/etc. + as appropriate. It is called automatically but will not take any action if + the build system is already established. + +* ``install``, which installs (or pretends to install) the module. Called + automatically by ``build``. + +* ``uninstall``, which uninstalls (or pretends to uninstall) the module. Not + normally called but can be configured to be called. + +* ``applyUserEnvironment``, this adds ``set-env`` module-specific environment + variable settings into the module's build context, called by + ``setupEnvironment``. This is needed since $ENV is not actually updated by + ksb::BuildContext until after a new child process is ``fork``'ed. + +* ``setupEnvironment``, called by the kdesrc-build build driver, running in a + subprocess, before calling the appropriate update/build/install etc. method. diff --git a/kdesrc-build b/kdesrc-build index a4cc72a..f555f8e 100755 --- a/kdesrc-build +++ b/kdesrc-build @@ -1,350 +1,448 @@ #!/usr/bin/env perl # Script to handle building KDE from source code. All of the configuration is # stored in the file ./kdesrc-buildrc (or ~/.kdesrc-buildrc, if that's not # present). # # Please also see the documentation that should be included with this program, # in the doc/ directory. # # Copyright © 2003 - 2018 Michael Pyne. # Home page: https://kdesrc-build.kde.org/ # # Copyright © 2005, 2006, 2008 - 2011 David Faure # Copyright © 2005 Thiago Macieira # Copyright © 2006 Stephan Kulow # Copyright © 2006, 2008 Dirk Mueller # ... and possibly others. Check the git source repository for specifics. # # This program is free software; you can redistribute it and/or modify it under # the terms of the GNU General Public License as published by the Free Software # Foundation; either version 2 of the License, or (at your option) any later # version. # # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more # details. # # You should have received a copy of the GNU General Public License along with # this program; if not, write to the Free Software Foundation, Inc., 51 # Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA # Adding an option? Grep for 'defaultGlobalOptions' in ksb::BuildContext --mpyne -use FindBin qw($RealBin); -use lib "$RealBin/../share/kdesrc-build/modules"; -use lib "$RealBin/modules"; - +use 5.014; # Require Perl 5.14 use strict; use warnings; -use Carp; -use Data::Dumper; -use File::Find; # For our lndir reimplementation. -use File::Path qw(remove_tree); +# On many container-based distros, even FindBin is missing to conserve space. +# But we can use File::Spec to do nearly the same. +my $RealBin; +my $modPath; + +# The File::Spec calls have to run when parsing (i.e. in BEGIN) to make the +# 'use lib' below work (which itself implicitly uses BEGIN { }) +BEGIN { + use File::Spec; + + # resolve symlinks + my $scriptPath = $0; + for (1..16) { + last unless -l $scriptPath; + $scriptPath = readlink $scriptPath; + } + die "Too many symlinks followed looking for script" if -l $scriptPath; -use Mojo::IOLoop; -use Mojo::Server::Daemon; + my ($volume, $directories, $script) = File::Spec->splitpath($scriptPath); -use ksb::Debug; -use ksb::Util; -use ksb::Version qw(scriptVersion); -use ksb::Application; -use ksb::UserInterface::TTY; -use web::BackendServer; + $RealBin = File::Spec->catpath($volume, $directories, ''); + die "Couldn't find base directory!" unless $RealBin; -use 5.014; # Require Perl 5.14 + # Use modules in git repo if running from git dir, otherwise assume + # system install + $modPath = File::Spec->rel2abs('modules', $RealBin); + $modPath = ($RealBin =~ s,/bin/?$,/share/kdesrc-build/modules,r) + unless -d $modPath; + + die "Couldn't find modules for kdesrc-build!" unless $modPath; +} + +use lib "$modPath"; # Make ksb:: modules available + +sub dumpError +{ + my $err = $@; + open my $fh, '>>', "error-$$.log" or return; + my $time = localtime; + say $fh $time; + say $fh $@; +} + +# When running in a limited environment, we might not be able to load +# our modules although we can find them. In this case we should help user +# by setting up system dependencies. +eval { + if (grep { $_ eq '--initial-setup' } @ARGV) { + require ksb::FirstRun; + require ksb::Debug; + ksb::Debug::setColorfulOutput(1); + exit ksb::FirstRun::setupUserSystem($RealBin); + } +}; + +if ($@) { + dumpError(); + say STDERR <import(); +ksb::Util->import(); +ksb::BuildException->import(); +ksb::Version->import(qw(scriptVersion)); +ksb::Application->import(); +ksb::UserInterface::TTY->import(); +web::BackendServer->import(); + +Mojo::IOLoop->import(); +Mojo::Server::Daemon->import(); # Make Perl 'plain die' exceptions use Carp::confess instead of their core # support. This is not supported by the Perl 5 authors but assuming it works # will be better than the alternative backtrace we get (which is to say, none) $SIG{__DIE__} = \&Carp::confess; -$ksb::Version::SCRIPT_PATH = $RealBin; +ksb::Version->path($RealBin); ### Script-global functions. # These functions might be called at runtime via log_command, using # log_command's support for symbolic execution of a named subroutine. Because # of that, they have been left in the top-level script. # # Everything else should be in an appropriate class. # Subroutine to recursively symlink a directory into another location, in a # similar fashion to how the XFree/X.org lndir() program does it. This is # reimplemented here since some systems lndir doesn't seem to work right. # # As a special exception to the GNU GPL, you may use and redistribute this # function however you would like (i.e. consider it public domain). # # The first parameter is the directory to symlink from. # The second parameter is the destination directory name. # # e.g. if you have $from/foo and $from/bar, lndir would create $to/foo and # $to/bar. # # All intervening directories will be created as needed. In addition, you # may safely run this function again if you only want to catch additional files # in the source directory. # # Note that this function will unconditionally output the files/directories # created, as it is meant to be a close match to lndir. # # RETURN VALUE: Boolean true (non-zero) if successful, Boolean false (0, "") # if unsuccessful. sub safe_lndir { my ($from, $to) = @_; # Create destination directory. if (not -e $to) { print "$to\n"; if (not pretending() and not super_mkdir($to)) { error ("Couldn't create directory r[$to]: b[r[$!]"); return 0; } } # Create closure callback subroutine. my $wanted = sub { my $dir = $File::Find::dir; my $file = $File::Find::fullname; $dir =~ s/$from/$to/; # Ignore the .svn directory and files. return if $dir =~ m,/\.svn,; # Create the directory. if (not -e $dir) { print "$dir\n"; if (not pretending()) { super_mkdir ($dir) or croak_runtime("Couldn't create directory $dir: $!"); } } # Symlink the file. Check if it's a regular file because File::Find # has no qualms about telling you you have a file called "foo/bar" # before pointing out that it was really a directory. if (-f $file and not -e "$dir/$_") { print "$dir/$_\n"; if (not pretending()) { symlink $File::Find::fullname, "$dir/$_" or croak_runtime("Couldn't create file $dir/$_: $!"); } } }; # Recursively descend from source dir using File::Find eval { find ({ 'wanted' => $wanted, 'follow_fast' => 1, 'follow_skip' => 2}, $from); }; if ($@) { error ("Unable to symlink $from to $to: $@"); return 0; } return 1; } # Subroutine to delete recursively, everything under the given directory, # unless we're in pretend mode. # # Used from ksb::BuildSystem to handle cleaning a build directory. # # i.e. the effect is similar to "rm -r $arg/* $arg/.*". # # This assumes we're called from a separate child process. Therefore the # normal logging routines are /not used/, since our output will be logged # by the parent kdesrc-build. # # The first parameter should be the absolute path to the directory to delete. # # Returns boolean true on success, boolean false on failure. sub prune_under_directory { my $dir = shift; my $errorRef; print "starting delete of $dir\n"; eval { remove_tree($dir, { keep_root => 1, error => \$errorRef }); }; if ($@ || @$errorRef) { error ("\tUnable to clean r[$dir]:\n\ty[b[$@]"); return 0; } return 1; } sub findMissingModules { # should be either strings of module names to be found or a listref containing # a list of modules where any one of which will work. my @requiredModules = ( 'HTTP::Tiny', 'IO::Socket::SSL', # Assume if Mojolicious::Lite is present, that whole framework is properly installed 'Mojolicious::Lite', 'Mojo::Promise', # That was a bad assumption 'Mojo::JSON', [qw(YAML::XS YAML::PP YAML::Syck)] ); my @missingModules; my $validateMod = sub { return eval "require $_[0]; 1;"; }; my $description; foreach my $neededModule (@requiredModules) { if (ref $neededModule) { # listref of options my @moduleOptions = @$neededModule; next if (ksb::Util::any (sub { $validateMod->($_); }, $neededModule)); $description = 'one of (' . join(', ', @moduleOptions) . ')'; } else { next if $validateMod->($neededModule); $description = $neededModule; } push @missingModules, $description; } return @missingModules; } # Rather than running an interactive build, launches a web server that can be # interacted with by and outside user interface, printing the URL to the server # on stdout and then remaining in the foreground until killed. sub launchBackend { # Manually setup the daemon so that we can figure out what port it # ends up on. my $daemon = Mojo::Server::Daemon->new( app => web::BackendServer->new, listen => ['http://localhost'], silent => 1, ); $daemon->start; # Grabs the socket to listen on my $port = $daemon->ports->[0] or do { say STDERR "Can't autodetect which TCP port was assigned!"; exit 1; }; say "http://localhost:$port"; Mojo::IOLoop->start unless Mojo::IOLoop->is_running; exit 0; } # Script starts. # Ensure some critical Perl modules are available so that the user isn't surprised # later with a Perl exception if(my @missingModuleDescriptions = findMissingModules()) { say <start() and then as an atexit handler app->ksb->finish) + # Use some exception handling to avoid ucky error messages eval { my $app = web::BackendServer->new(@ARGV); my $ui = ksb::UserInterface::TTY->new($app); - # Hack for debugging current state. - if (exists $ENV{KDESRC_BUILD_DUMP_CONTEXT}) { - local $Data::Dumper::Indent = 1; - local $Data::Dumper::Sortkeys = 1; - - # This method call dumps the first list with the variables named by the - # second list. - print Data::Dumper->Dump([$app->ksb->context()], [qw(ctx)]); - } - push @atexit_subs, sub { $app->ksb->finish(99) }; # TODO: Reimplement --print-modules, --query modes, which wouldn't go through ->start my $result = $ui->start(); @atexit_subs = (); # Clear exit handlers # env driver is just the ~/.config/kde-env-*.sh, session driver is that + ~/.xsession my $ctx = $app->context; if ($ctx->getOption('install-environment-driver') || $ctx->getOption('install-session-driver')) { ksb::Application::_installCustomSessionDriver($ctx); } # Exits the script my $logdir = $app->context()->getLogDir(); note ("Your logs are saved in y[$logdir]"); exit $result; }; if (my $err = $@) { if (had_an_exception()) { say "kdesrc-build encountered an exceptional error condition:"; say " ========"; say " $err"; say " ========"; say "\tCan't continue, so stopping now."; say "\nPlease submit a bug against kdesrc-build on https://bugs.kde.org/" if ($err->{exception_type} eq 'Internal'); } else { # An exception was raised, but not one that kdesrc-build generated say "Encountered an error in the execution of the script."; say "The error reported was $err"; say "Please submit a bug against kdesrc-build on https://bugs.kde.org/"; } exit 99; } # vim: set et sw=4 ts=4: diff --git a/kdesrc-build-setup b/kdesrc-build-setup index 2999c70..b95a62d 100755 --- a/kdesrc-build-setup +++ b/kdesrc-build-setup @@ -1,449 +1,482 @@ #!/usr/bin/env perl # Script to create a configuration file for kdesrc-build. # # Copyright © 2011, 2016 Michael Pyne. # Home page: https://kdesrc-build.kde.org/ # # This program is free software; you can redistribute it and/or modify it under # the terms of the GNU General Public License as published by the Free Software # Foundation; either version 2 of the License, or (at your option) any later # version. # # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more # details. # # You should have received a copy of the GNU General Public License along with # this program; if not, write to the Free Software Foundation, Inc., 51 # Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA use strict; use 5.018; use IO::Pipe; use File::Copy; use File::Temp qw/tempfile/; use File::Basename; use Cwd qw(abs_path); our $VERSION = 0.03; # Not user-visible yet. sub clearScreen { require POSIX; my $termios = POSIX::Termios->new(); $termios->getattr(1); # Get STDOUT attributes require Term::Cap; my $terminal = Term::Cap->Tgetent({OSPEED => $termios->getospeed}); # Force the clear characters to be output immediately. # Otherwise it might overlap with other output, like error messages. local $| = 1; print $terminal->Tputs('cl', 0); return 0; } sub runDialogExecutable { my (@args) = @_; # Allow for 2 more file descriptors (on top of the normally allowed 0, 1, # 2) to survive the upcoming exec # See "SYSTEM_FD_MAX" in perldoc:perlvar $^F = 4; my $pipe = new IO::Pipe; my $pid; if ($pid = fork()) { # Parent $pipe->reader(); my $output = <$pipe>; waitpid $pid, 0; my $result = ($? >> 8); $pipe->close(); # dialog uses -1 as an exit code, Perl gets just the standard 8 bits # the rest of UNIX uses... if ($? == -1) { clearScreen(); die "Failed to run dialog(1): $@"; } elsif ($result == 255) { clearScreen(); die "Canceled the dialog"; } return $output || $result; } elsif (defined $pid) { # Child $pipe->writer(); my $outputFd = $pipe->fileno(); print "Using fd $outputFd"; exec ('dialog', '--output-fd', $outputFd, '--backtitle', 'kdesrc-build setup', @args); } else { die "Unable to fork? $!"; } } sub getUserInput { my $prompt = shift; my $default = shift; my @args = qw/--inputbox 8 50/; splice @args, 1, 0, $prompt; push @args, $default if $default; return runDialogExecutable(@args); } sub getMenuOption { my ($prompt, @opts) = @_; @opts = @{$opts[0]} if ref $opts[0] eq 'ARRAY'; my @args = qw/--menu 20 70 18/; splice @args, 1, 0, $prompt; while(my ($k, $v) = splice (@opts, 0, 2)) { push @args, $k, $v; } return runDialogExecutable(@args); } sub showInfo { my $message = shift; my @args = qw/--msgbox 20 62/; splice @args, 1, 0, $message; return runDialogExecutable(@args); } sub getYesNoAnswer { my $prompt = shift; my @args = qw/--yesno 8 55/; splice @args, 1, 0, $prompt; return runDialogExecutable(@args) == 0; } sub getDirectory { my $dir = shift; my @args = qw/--dselect 10 70/; splice @args, 1, 0, $dir; return runDialogExecutable(@args); } sub getListOptions { my ($prompt, $opts, $enabled) = @_; die "\$opts not a hash ref" unless (ref $opts eq 'ARRAY'); die "\$enabled not a hash ref" unless (ref $enabled eq 'HASH'); my @args = qw/--checklist 20 70 18/; splice @args, 1, 0, $prompt; splice @args, 0, 0, '--output-separator', ','; while (my ($k, $v) = splice(@{$opts}, 0, 2)) { push (@args, $k, $v, (exists ${$enabled}{$k} ? 'on' : 'off')); } my $output = runDialogExecutable(@args); # Filter out empty results, remove quotes. my @items = split (/,/, $output); - s/^"(.*)"$/\1/ foreach @items; + s/^"(.*)"$/$1/ foreach @items; @items = grep { length $_ } @items; return @items; } # The 'dialog(1)' program is required, verify it exists before going # further. # We use the --help option since it doesn't send weird terminal characters to the screen # and it's supported on dialog and Debian's dialog replacement called whiptail. system('dialog', '--help') == 0 or do { my $osError = "$!"; say "Unable to run the dialog(1) program, it is required for this setup script."; if ($? == -1) { say "\tThe program wouldn't even run, due to error: $osError"; } else { say "\tProgram ran, but exited with error: ", $? >> 8; } exit 1; }; showInfo(< "$ENV{HOME}/kde/usr (default)", custom => "Custom location, chosen next screen", ]); if ($installDir eq 'custom') { $installDir = getDirectory('/usr/local/kde'); } else { $installDir = "~/kde/usr"; } +my $sourceDir = getMenuOption('Where do you want the source code to be saved?', + [ + home => "$ENV{HOME}/kde/src (default)", + custom => "Custom location, chosen next screen", + ]); + +if ($sourceDir eq 'custom') { + $sourceDir = getDirectory('/usr/local/kde/src'); +} +else { + $sourceDir = "~/kde/src"; +} + +my $buildDir = getMenuOption('Where do you want temporary build files to be saved? (They might need lots of space)', + [ + home => "$ENV{HOME}/kde/build (default)", + custom => "Custom location, chosen next screen", + ]); + +if ($buildDir eq 'custom') { + $buildDir = getDirectory('/usr/local/kde/build'); +} +else { + $buildDir = "~/kde/build"; +} + my @chosenModules = getListOptions( "Which major module groups do you want to build?", [ frameworks => 'KDE Frameworks 5 - Essential libraries/runtime (required)', workspace => 'KDE Plasma 5 Desktop and workspace', base => 'Assorted useful KF5-based applications', pim => 'Personal Information Management software', ], { frameworks => 1, workspace => 1, base => 1, }, ); my $numCpus = getUserInput( 'How many CPU cores do you wish to use for building?', '4'); my $outputFileName = "$ENV{HOME}/.kdesrc-buildrc"; my $output; # Will be output filehandle. while (-e $outputFileName) { (my $printableName = $outputFileName) =~ s/^$ENV{HOME}/~/; my $outputChoice = getMenuOption( "$printableName already exists, what do you want to do?", [ backup => 'Make a backup, then overwrite with the new configuration', custom => 'Write the new configuration to a different file', cancel => 'Cancel setup', ], ); if ($outputChoice eq 'cancel') { showInfo('Setup canceled'); exit 0; } if ($outputChoice eq 'custom') { $outputFileName = getUserInput('Enter desired configuration file name.'); $outputFileName =~ s/^~/$ENV{HOME}/; } if ($outputChoice eq 'backup') { copy($outputFileName, "$outputFileName~") or do { my $error = "$!"; showInfo(<', $outputFileName) or do { my $error = "$!"; showInfo (< ... end module as normal after the module-set, but keep in mind -# if you do this that you won't change the order the modules are built in. -# -# Example: -module-set - # Special handling occurs with this option when used in module-set so you - # don't have to re-type repository names. - repository kde-projects - - # automoc is essential for building KDE's CMake-based modules, and so should be first - # in this module set (but after Qt, if you're building that too) - use-modules automoc cagibi attica polkit-qt-1 - - # Other options are simply passed to each defined module. For example if - # you uncomment the next line, then the "Debug" build type will be used for - # every module in this set, which makes modules optimized but still - # debuggable. - # cmake-options -DCMAKE_BUILD_TYPE=Debug -end module-set - -# "options" requires kdesrc-build on or after 11-Jan-2014. -options attica - cmake-options -DQT4_BUILD=TRUE # Required if both Qt4 and 5 are present. -end options - -# Phonon is the KDE multimedia layer. -# It is required for the KDE libraries, and a specific backend for your system -# is also required. For Linux users, this means either phonon-gstreamer or -# phonon-vlc -module-set phonon - repository kde-projects - - # We avoid using just "phonon" as kdesrc-build will include all submodules - # that have phonon as part of their path. (i.e. it means phonon/*), but we - # don't want all the phonon backends. - use-modules phonon/phonon phonon-gstreamer # or you can try phonon-vlc -end module-set - -# This set includes the modules required for the "strigi" file analyzer, used -# to extract information contained in various file types for Dolphin previews, -# Nepomuk tagging, etc. -module-set strigi - repository kde-projects - - # Not all modules in strigi are built, and there is a certain order required. - # See kde-build-metadata.git/{dependency-data,build-script-ignore}, which - # are used automatically by kdesrc-build. - use-modules kdesupport/strigi -end module-set - -# kdesupport contains QCA, oxygen icons, and a few other small things. -module kdesupport -end module - -# Support for notification area menus via the DBusMenu protocol -# This is needed by kdelibs. -# -# This is commented out as this is the only module that requires the 'bzr' -# source control software, and a recent libdbusmenu-qt development package from -# your distribution should meet the kdelibs dependency. If you wish to install -# this module, ensure you have the 'bzr' tool available and then uncomment this -# module. -#module libdbusmenu-qt - # The lp: prefix refers to Canonical's Launchpad repository -# repository bzr://lp:libdbusmenu-qt -#end module - -# TagLib used to be in kdesupport and is used by JuK and Amarok for parsing -# audio metadata. It is required for JuK, amarok (though typically the -# system-provided taglib will suffice). -module taglib - repository git://github.com/taglib/taglib.git - - # Note: -DWITH_ASF=TRUE and -DWITH_MP4=TRUE (for taglib) is required to - # allow Amarok (defined below, near the end of this file) to build. - cmake-options -DWITH_ASF=TRUE -DWITH_MP4=TRUE -end module - -module-set - repository kde-projects - use-modules extra-cmake-modules -end module-set - -# kdelibs and the sub-libraries in its group are the base KDE libraries needed -# by all KDE 4 applications. -# kde-runtime contains applications that are required for the operation of -# some base KDE libraries. -module-set - repository kde-projects - - # Note that 'kdelibs' is itself a module and a group pulling in things like - # kactivities and baloo-widgets. Rather than specifying all the modules I - # just let kdesrc-build figure it out, at least while they're still - # changing. - use-modules kdelibs kde-runtime - - # These are pulled in by kdelibs and are still required by some extragear modules, but - # are optional or no longer required for kde.org modules. Remove this line if you need to - # build Nepomuk, but if you need to build nepomuk you'd also want to add "soprano" to - # use-modules above. - ignore-modules nepomuk-core nepomuk-widgets - -# KDE 4 uses CMake, if you need to pass options to the cmake command, use this -# option: -# cmake-options -DKDE4_BUILD_TESTS:BOOL=ON -end module-set - -# The next module-set completes a base workspace. kdepimlibs should be compiled -# before the workspace and Plasma addons are compiled, and kdepimlibs itself -# requires akonadi. -# From there kde-workspace contains programs like Plasma Desktop and the KWin -# window manager, kde-baseapps contains core applications, -# and I also add konsole and kate since they are also very useful in general. -module-set - repository kde-projects - - use-modules akonadi kdepimlibs kde-workspace \ - kate kde-baseapps konsole -end module-set - -# On OpenSUSE, for unlocking to work, you need to do this: -#module kde-workspace - #cmake-options -DKDE4_COMMON_PAM_SERVICE=xdm -#end module - -# KDE/kde-wallpapers contains all wallpapers for your desktop -module kde-wallpapers -end module - -# KDE/kde-base-artwork contains the default splash screen -module kde-base-artwork -end module - -# kdemultimedia contains JuK, Dragon Player and other KDE multimedia -# applications. It does not include amarok, which is in git.kde.org -module-set - repository kde-projects - use-modules kdemultimedia - -# Example of how to ignore a module. kdemultimedia includes thumbnail -# generators for video files based on either mplayer or ffmpeg. You'd usually -# only want one. You can use ignore-modules to ignore the one you don't want -# (though you can build them both if desired). - ignore-modules ffmpegthumbs -# ignore-modules mplayerthumbs - -end module-set - -# ... Well, they're games. ;) -module-set - repository kde-projects - use-modules kdegames -end module-set - -# kdesdk is a useful module for software developers. Programmers *need* this -# module for kcachegrind, but in addition there are several useful -# documentation kioslave formatters for use in konqueror. -module-set - repository kde-projects - use-modules kdesdk -end module-set - -# kdenetwork has Kopete and other useful applications for the Internet and -# other networks. -module-set - repository kde-projects - use-modules kdenetwork -end module - -# kdepim contains KMail, Kontact, KOrganizer, and other insanely useful -# programs that help you keep track of things. It consists of two core -# components, kdepim-runtime, and kdepim itself, which both depend on -# kdepimlibs. -module-set - repository kde-projects - - use-modules kdepim-runtime kdepim -end module-set - -# kdeaccessibility accessibility tools -#module-set -# repository kde-projects -# use-modules kdeaccessibility -#end module-set - -# kdeartwork has themes and screensaver -#module kdeartwork -#end module - -# kdeutils has miscellaneous programs which can be useful. You probably won't -# die if you remove this from the config file though. -module-set kdeutils - repository kde-projects - - use-modules kdeutils -end module-set - -# kdegraphics contains various programs useful for graphics editing. It -# doesn't include Krita, which is part of Calligra, but it is worth it just for -# KolourPaint and Gwenview. -# -# Note that this just references the KDE Projects database, so this will expand -# into many more modules. -module-set - repository kde-projects - - use-modules kdegraphics -end module-set - -# Educational programs. Some are actually quite fun even if you're not trying -# to learn anything. -module-set kdeedu - repository kde-projects - - use-modules kdeedu -end module-set - -# Extra collection of useful plasma applets, runners, data engines, etc. -module-set - repository kde-projects - - use-modules kdeplasma-addons -end module-set - -## A prerequisite for kdevelop other modules using the kdevelop platform, like -# kdewebdev -#module-set -# use-modules kdevplatform -# repository kde-projects -#end module-set - -## The KDevelop IDE, useful for developing all kinds of programs. If you don't -# plan on being a software developer you can save time by removing this from -# your configuration. -#module-set -# use-modules kdevelop -# repository kde-projects -#end module-set - -# Modules in extragear and playground can also be added. -# -# To see what you can find in the various modules, browse -# https://projects.kde.org/projects/kde/extragear or -# https://projects.kde.org/projects/kde/playground - -# Amarok is a KDE multimedia application extraordinaire. -# If you want to build and install amarok, simply uncomment this module -# NOTE: Ensure you've enabled ASF and MP4 support above in taglib. (If you -# build the taglib module by itself instead of using your distro's taglib, -# then make sure you've enabled this support for taglib). -#module-set amarok -# repository kde-projects -# -# use-modules amarok -#end module - -# --- The K3B cd/dvd/etc. burner. -#module-set -# repository kde-projects -# -# use-modules k3b -#end module-set - -# Calligra Office Suite -#module-set -# repository kde-projects -# -# use-modules calligra -#end module-set - -# Add more modules as needed. diff --git a/kf5-frameworks-build-include b/kf5-frameworks-build-include index f4d4bc3..67707df 100644 --- a/kf5-frameworks-build-include +++ b/kf5-frameworks-build-include @@ -1,100 +1,100 @@ # Module definitions for building KDE Frameworks 5 # (cmake, KF5's dependencies, KDE Frameworks 5) # Usage: Write your own kdesrc-buildrc with only a "global" section # then include this file, like this: # # include extragear/utils/kdesrc-build/kf5-qt5-build-include # (or using a full path) # # You can then add additional modules if desired. # # This file uses "branch groups" to decide which git branch to use. If you # need to add your framework or library here please be sure to update # kde-build-metadata repo's "logical-module-structure". It includes a simple # tool you can use to validate your change works (or just "kdesrc-build -p # your-module" and look for the right branch). # ============================ Dependencies ========================== module libdbusmenu-qt # The lp: prefix refers to Canonical's Launchpad repository repository bzr://lp:libdbusmenu-qt end module module taglib repository git://github.com/taglib/taglib.git branch master # ASF/MP4 options are required for Amarok. Also need to force shared libs cmake-options -DWITH_ASF=TRUE -DWITH_MP4=TRUE -DBUILD_SHARED_LIBS=TRUE end module # kdesrc-build itself, and some "kdesupport" modules needed by KF5, workspace or apps. module-set repository kde-projects use-modules kdesrc-build kde-dev-scripts extra-cmake-modules polkit-qt-1 qca - cmake-options -DCMAKE_BUILD_TYPE:STRING=debug end module-set module-set phonon repository kde-projects cmake-options -DPHONON_BUILD_PHONON4QT5=ON # We avoid using just "phonon" as kdesrc-build will include all submodules # that have phonon as part of their path. (i.e. it means phonon/*), but we # don't want all the phonon backends. use-modules phonon/phonon phonon-vlc phonon-gstreamer end module-set # ============================= KDE Frameworks ======================== module-set frameworks repository kde-projects use-modules frameworks - # The CodeBlocks generator allows usage in QtCreator, while still generating Makefiles + # The CodeBlocks generator allows usage in QtCreator, while still generating Makefiles # if you use Make as build system add to cmake-options -G "CodeBlocks - Unix Makefiles" # if you use Ninja as build system add to cmake-options -G "CodeBlocks - Ninja" # see http://www.cmake.org/cmake/help/v3.0/generator/CodeBlocks.html - cmake-options -DBUILD_TESTING=TRUE -DCMAKE_BUILD_TYPE:STRING=debug + cmake-options -DBUILD_TESTING=TRUE #tag v5.50.0-rc1 end module-set -# Example of how to set options for just one module from a module-set... this is -# useful to have *after* your "include .../kf5-framework-build-include" in your +# Set some options for the module kactivities. +# This also serves as an example of how to set options for just one module from a module-set... +# this is useful to have *after* your "include .../kf5-framework-build-include" in your # kdesrc-buildrc if you just want to tweak some settings without adding/removing # modules. options kactivities cmake-options -DKDE4_BUILD_TESTS=TRUE -DBUILD_TESTING=TRUE \ - -DKACTIVITIES_ENABLE_EXCEPTIONS=TRUE -DCMAKE_BUILD_TYPE:STRING=debug + -DKACTIVITIES_ENABLE_EXCEPTIONS=TRUE end options options bluez-qt # Default udev rules dir /lib/udev/rules.d is not writable by regular user cmake-options -DINSTALL_UDEV_RULE:BOOL=OFF end options module grantlee repository https://github.com/steveire/grantlee.git branch master end module # gpgme master requires a recent libgpg-error module libgpg-error repository git://git.gnupg.org/libgpg-error.git branch master configure-flags --enable-maintainer-mode end module # gpgme master is currently required for gpgmepp module gpgme repository git://git.gnupg.org/gpgme.git branch master configure-flags --enable-maintainer-mode --enable-languages=cpp,qt end module # kirigami is not a framework but used by workspace (e.g. plasma-discover) and apps (e.g. peruse) module-set kirigami repository kde-projects use-modules kirigami end module-set diff --git a/modules/ksb/Application.pm b/modules/ksb/Application.pm index d77e238..a9c6e56 100644 --- a/modules/ksb/Application.pm +++ b/modules/ksb/Application.pm @@ -1,2327 +1,2293 @@ package ksb::Application 0.20; # Class: Application # # Contains the application-layer logic (i.e. creating a build context, reading # options, parsing command-line, etc.) use strict; use warnings; use 5.014; no if $] >= 5.018, 'warnings', 'experimental::smartmatch'; use ksb::Debug 0.30; use ksb::Util; use ksb::BuildContext 0.35; use ksb::BuildSystem::QMake; use ksb::BuildException 0.20; +use ksb::FirstRun; use ksb::Module; use ksb::ModuleResolver 0.20; use ksb::ModuleSet 0.20; use ksb::ModuleSet::KDEProjects; use ksb::OSSupport; use ksb::PromiseChain; use ksb::RecursiveFH; use ksb::DependencyResolver 0.20; use ksb::Updater::Git; use ksb::Version qw(scriptVersion); use Mojo::IOLoop; use Mojo::Promise; use Fcntl; # For sysopen use List::Util qw(first min); use File::Basename; # basename, dirname use File::Glob ':glob'; use POSIX qw(:sys_wait_h _exit :errno_h); use Getopt::Long qw(GetOptionsFromArray :config gnu_getopt nobundling); use IO::Handle; use IO::Select; ### Package-specific variables (not shared outside this file). use constant { # We use a named remote to make some git commands work that don't accept the # full path. KDE_PROJECT_ID => 'kde-projects', # git-repository-base for kde_projects.xml }; ### Package methods sub new { my ($class, @options) = @_; my $self = bless { context => ksb::BuildContext->new(), metadata_module => undef, run_mode => 'build', modules => undef, module_resolver => undef, # ksb::ModuleResolver but see below _base_pid => $$, # See finish() }, $class; # Default to colorized output if sending to TTY ksb::Debug::setColorfulOutput(-t STDOUT); return $self; } # Call after establishContext (to read in config file and do one-time metadata # reading). # # Need to call this before you call startHeadlessBuild sub setModulesToProcess { my ($self, @modules) = @_; $self->{modules} = \@modules; $self->context()->addModule($_) foreach @modules; # i.e. niceness, ulimits, etc. $self->context()->setupOperatingEnvironment(); } # Sets the application to be non-interactive, intended to make this suitable as # a backend for a Mojolicious-based web server with a separate U/I. sub setHeadless { my $self = shift; $self->{run_mode} = 'headless'; return $self; } # Method: _readCommandLineOptionsAndSelectors # # Returns a list of module/module-set selectors, selected module/module-set # options, and global options, based on the command-line arguments passed to # this function. # # This is a package method, should be called as # $app->_readCommandLineOptionsAndSelectors # # Phase: # initialization - Do not call from this function. # # Parameters: # cmdlineOptions - hashref to hold parsed modules options to be applied later. # *Note* this must be done separately, it is not handled by this subroutine. # Global options will be stored in a hashref at $cmdlineOptions->{global}. # Module or module-set options will be stored in a hashref at # $cmdlineOptions->{$moduleName} (it will be necessary to disambiguate # later in the run whether it is a module set or a single module). # # If the global option 'start-program' is set, then the program to start and # its options will be found in a listref pointed to under the # 'start-program' option. # # selectors - listref to hold the list of module or module-set selectors to # build, in the order desired by the user. These will just be strings, the # caller will have to figure out whether the selector is a module or # module-set, and create any needed objects, and then set the recommended # options as listed in cmdlineOptions. # # ctx - to hold the global build state. # # @options - The remainder of the arguments are treated as command line # arguments to process. # # Returns: # Nothing. An exception will be raised on failure, or this function may quit # the program directly (e.g. to handle --help, --usage). sub _readCommandLineOptionsAndSelectors { my $self = shift; my ($cmdlineOptionsRef, $selectorsRef, $ctx, @options) = @_; my $phases = $ctx->phases(); my @savedOptions = @options; # Copied for use in debugging. my $os = ksb::OSSupport->new; my $version = "kdesrc-build " . scriptVersion(); my $author = < Many people have contributed code, bugfixes, and documentation. Please report bugs using the KDE Bugzilla, at https://bugs.kde.org/ DONE # Getopt::Long will store options in %foundOptions, since that is what we # pass in. To allow for custom subroutines to handle an option it is # required that the sub *also* be in %foundOptions... whereupon it will # promptly be overwritten if we're not careful. Instead we let the custom # subs save to %auxOptions, and read those in back over it later. my (%foundOptions, %auxOptions); %foundOptions = ( + 'show-info' => sub { say $version; say "OS: ", $os->vendorID(); exit }, + 'initial-setup' => sub { exit $self->performInitialUserSetup() }, version => sub { say $version; exit }, author => sub { say $author; exit }, - 'show-info' => sub { say $version; say "OS: ", $os->vendorID(); exit }, help => sub { _showHelpMessage(); exit 0 }, install => sub { $self->{run_mode} = 'install'; $phases->phases('install'); }, uninstall => sub { $self->{run_mode} = 'uninstall'; $phases->phases('uninstall'); }, 'no-src' => sub { $phases->filterOutPhase('update'); }, 'no-install' => sub { $phases->filterOutPhase('install'); }, + 'no-snapshots' => sub { + # The documented form of disable-snapshots + $auxOptions{'disable-snapshots'} = 1; + }, 'no-tests' => sub { # The "right thing" to do $phases->filterOutPhase('test'); # What actually works at this point. $foundOptions{'run-tests'} = 0; }, 'no-build' => sub { $phases->filterOutPhase('build'); }, # Mostly equivalent to the above 'src-only' => sub { $phases->phases('update'); # We have an auto-switching function that we only want to run # if --src-only was passed to the command line, so we still # need to set a flag for it. $foundOptions{'allow-auto-repo-move'} = 1; }, 'build-only' => sub { $phases->phases('build'); }, 'install-only' => sub { $self->{run_mode} = 'install'; $phases->phases('install'); }, prefix => sub { my ($optName, $arg) = @_; $auxOptions{prefix} = $arg; $foundOptions{kdedir} = $arg; #TODO: Still needed for compat? $foundOptions{reconfigure} = 1; }, query => sub { my (undef, $arg) = @_; my $validMode = qr/^[a-zA-Z0-9_][a-zA-Z0-9_-]*$/; die("Invalid query mode $arg") unless $arg =~ $validMode; # Add useful aliases $arg = 'source-dir' if $arg =~ /^src-?dir$/; $arg = 'build-dir' if $arg =~ /^build-?dir$/; $arg = 'install-dir' if $arg eq 'prefix'; $self->{run_mode} = 'query'; $auxOptions{query} = $arg; $auxOptions{pretend} = 1; # Implied pretend mode }, pretend => sub { # Set pretend mode but also force the build process to run. $auxOptions{pretend} = 1; $foundOptions{'build-when-unchanged'} = 1; }, resume => sub { $auxOptions{resume} = 1; $phases->filterOutPhase('update'); # Implied --no-src $foundOptions{'no-metadata'} = 1; # Implied --no-metadata }, verbose => sub { $foundOptions{'debug-level'} = ksb::Debug::WHISPER }, quiet => sub { $foundOptions{'debug-level'} = ksb::Debug::NOTE }, 'really-quiet' => sub { $foundOptions{'debug-level'} = ksb::Debug::WARNING }, debug => sub { $foundOptions{'debug-level'} = ksb::Debug::DEBUG; debug ("Commandline was: ", join(', ', @savedOptions)); }, # Hack to set module options 'set-module-option-value' => sub { my ($optName, $arg) = @_; my ($module, $option, $value) = split (',', $arg, 3); if ($module && $option) { $cmdlineOptionsRef->{$module} //= { }; $cmdlineOptionsRef->{$module}->{$option} = $value; } }, # Getopt::Long doesn't set these up for us even though we specify an # array. Set them up ourselves. 'start-program' => [ ], 'ignore-modules' => [ ], # Module selectors, the <> is Getopt::Long shortcut for an # unrecognized non-option value (i.e. an actual argument) '<>' => sub { my $arg = shift; push @{$selectorsRef}, $arg; }, ); # Handle any "cmdline-eligible" options not already covered. my $flagHandler = sub { my ($optName, $optValue) = @_; # Assume to set if nothing provided. $optValue = 1 if (!defined $optValue or $optValue eq ''); $optValue = 0 if lc($optValue) eq 'false'; $optValue = 0 if !$optValue; $auxOptions{$optName} = $optValue; }; foreach my $option (keys %ksb::BuildContext::defaultGlobalFlags) { if (!exists $foundOptions{$option}) { $foundOptions{$option} = $flagHandler; # A ref to a sub here! } } # Actually read the options. my $optsSuccess = GetOptionsFromArray(\@options, \%foundOptions, - 'version', 'author', 'help', 'show-info', 'disable-snapshots|no-snapshots', + # Options here should not duplicate the flags and options defined below + # from ksb::BuildContext! + 'version|v', 'author', 'help', 'show-info', 'initial-setup', 'install', 'uninstall', 'no-src|no-svn', 'no-install', 'no-build', 'no-tests', 'build-when-unchanged|force-build', 'no-metadata', - 'verbose|v', 'quiet|quite|q', 'really-quiet', 'debug', + 'verbose', 'quiet|quite|q', 'really-quiet', 'debug', 'reconfigure', 'colorful-output|color!', 'src-only|svn-only', 'build-only', 'install-only', 'build-system-only', 'rc-file=s', 'prefix=s', 'niceness|nice:10', 'ignore-modules=s{,}', 'print-modules', 'pretend|dry-run|p', 'refresh-build', 'query=s', 'start-program|run=s{,}', 'launch-browser', 'revision=i', 'resume-from=s', 'resume-after=s', - 'rebuild-failures', 'resume', 'stop-on-failure', + 'rebuild-failures', 'resume', 'stop-after=s', 'stop-before=s', 'set-module-option-value=s', 'metadata-only', 'include-dependencies', # Special sub used (see above), but have to tell Getopt::Long to look - # for strings - (map { "$_:s" } (keys %ksb::BuildContext::defaultGlobalFlags)), + # for negatable boolean flags + (map { "$_!" } (keys %ksb::BuildContext::defaultGlobalFlags)), # Default handling fine, still have to ask for strings. (map { "$_:s" } (keys %ksb::BuildContext::defaultGlobalOptions)), '<>', # Required to read non-option args ); if (!$optsSuccess) { croak_runtime("Error reading command-line options."); } # To store the values we found, need to strip out the values that are # subroutines, as those are the ones we created. Alternately, place the # subs inline as an argument to the appropriate option in the # GetOptionsFromArray call above, but that's ugly too. my @readOptionNames = grep { ref($foundOptions{$_}) ne 'CODE' } (keys %foundOptions); # Slice assignment: $left{$key} = $right{$key} foreach $key (@keys), but # with hashref syntax everywhere. @{ $cmdlineOptionsRef->{'global'} }{@readOptionNames} = @foundOptions{@readOptionNames}; @{ $cmdlineOptionsRef->{'global'} }{keys %auxOptions} = values %auxOptions; } # Generates the build context, builds various module, dependency and branch # group resolvers, and splits up the provided option/selector mix read from # cmdline into selectors (returned to caller, if any) and pre-built context and # resolvers. # # Use "modulesFromSelectors" to further generate the list of ksb::Modules in # dependency order. # # After this function is called all module set selectors will have been # expanded, and we will have downloaded kde-projects metadata. # # Returns: List of Selectors to build. sub establishContext { my $self = shift; my @argv = @_; # Note: Don't change the order around unless you're sure of what you're # doing. my $ctx = $self->context(); my $cmdlineOptions = { global => { }, }; my $cmdlineGlobalOptions = $cmdlineOptions->{global}; my $deferredOptions = { }; # 'options' blocks # Process --help, --install, etc. first. my @selectors; $self->_readCommandLineOptionsAndSelectors($cmdlineOptions, \@selectors, $ctx, @argv); # Convert list to hash for lookup my %ignoredSelectors = map { $_, 1 } @{$cmdlineGlobalOptions->{'ignore-modules'}}; my @startProgramAndArgs = @{$cmdlineGlobalOptions->{'start-program'}}; delete @{$cmdlineGlobalOptions}{qw/ignore-modules start-program/}; # rc-file needs special handling. if (exists $cmdlineGlobalOptions->{'rc-file'} && $cmdlineGlobalOptions->{'rc-file'}) { $ctx->setRcFile($cmdlineGlobalOptions->{'rc-file'}); } my $fh = $ctx->loadRcFile(); $ctx->loadPersistentOptions(); if (exists $cmdlineGlobalOptions->{'resume'}) { my $moduleList = $ctx->getPersistentOption('global', 'resume-list'); if (!$moduleList) { error ("b[--resume] specified, but unable to find resume point!"); error ("Perhaps try b[--resume-from] or b[--resume-after]?"); croak_runtime("Invalid --resume flag"); } unshift @selectors, split(/,\s*/, $moduleList); } if (exists $cmdlineGlobalOptions->{'rebuild-failures'}) { my $moduleList = $ctx->getPersistentOption('global', 'last-failed-module-list'); if (!$moduleList) { error ("b[y[--rebuild-failures] was specified, but unable to determine"); error ("which modules have previously failed to build."); croak_runtime("Invalid --rebuild-failures flag"); } unshift @selectors, split(/,\s*/, $moduleList); } # _readConfigurationOptions will add pending global opts to ctx while ensuring # returned modules/sets have any such options stripped out. It will also add # module-specific options to any returned modules/sets. my @optionModulesAndSets = _readConfigurationOptions($ctx, $fh, $deferredOptions); close $fh; # Check if we're supposed to drop into an interactive shell instead. If so, # here's the stop off point. if (@startProgramAndArgs) { $ctx->setupEnvironment(); # Read options from set-env $ctx->commitEnvironmentChanges(); # Apply env options to environment _executeCommandLineProgram(@startProgramAndArgs); # noreturn } # Everything else in cmdlineOptions should be OK to apply directly as a module # or context option. $ctx->setOption(%{$cmdlineGlobalOptions}); # Selecting modules or module sets would requires having the KDE # build metadata (kde-build-metadata and sysadmin/repo-metadata) # available. $ctx->setKDEDependenciesMetadataModuleNeeded(); $ctx->setKDEProjectsMetadataModuleNeeded(); if (!exists $ENV{HARNESS_ACTIVE}) { # Running in a test harness, avoid downloading metadata which will be # ignored in the test or making changes to git config ksb::Updater::Git::verifyGitConfig(); $self->_downloadKDEProjectMetadata(); } # The user might only want metadata to update to allow for a later # --pretend run, check for that here. if (exists $cmdlineGlobalOptions->{'metadata-only'}) { return; } # At this point we have our list of candidate modules / module-sets (as read in # from rc-file). The module sets have not been expanded into modules. # We also might have cmdline "selectors" to determine which modules or # module-sets to choose. First let's select module sets, and expand them. my @globalCmdlineArgs = keys %{$cmdlineGlobalOptions}; my $commandLineModules = scalar @selectors; my $moduleResolver = $self->{module_resolver} = ksb::ModuleResolver->new($ctx); $moduleResolver->setCmdlineOptions($cmdlineOptions); $moduleResolver->setDeferredOptions($deferredOptions); $moduleResolver->setInputModulesAndOptions(\@optionModulesAndSets); $moduleResolver->setIgnoredSelectors([keys %ignoredSelectors]); return @selectors; } # Requires establishContext to have been called first. Converts string-based # "selectors" for modules or module-sets into a list of ksb::Modules (only # modules, no sets). # # After this function is called all module set selectors will have been # expanded, and we will have downloaded kde-projects metadata. # -# The modules returns must still be added (using setModulesToProcess) to the +# The modules returned must still be added (using setModulesToProcess) to the # context if you intend to build. This is a separate step to allow for some # introspection prior to making choice to build. # # Returns: List of Modules to build. sub modulesFromSelectors { my ($self, @selectors) = @_; my $moduleResolver = $self->{module_resolver}; my $ctx = $self->context(); my @modules; if (@selectors) { @modules = $moduleResolver->resolveSelectorsIntoModules(@selectors); - - ksb::Module->setModuleSource('cmdline'); } else { # Build everything in the rc-file, in the order specified. my @rcfileModules = @{$moduleResolver->{inputModulesAndOptions}}; @modules = $moduleResolver->expandModuleSets(@rcfileModules); - - ksb::Module->setModuleSource('config'); } # If modules were on the command line then they are effectively forced to # process unless overridden by command line options as well. If phases # *were* overridden on the command line, then no update pass is required # (all modules already have correct phases) @modules = _updateModulePhases(@modules) unless @selectors; # TODO: Verify this does anything still my $metadataModule = $ctx->getKDEDependenciesMetadataModule(); $ctx->addToIgnoreList($metadataModule->scm()->ignoredModules()); # Remove modules that are explicitly blanked out in their branch-group # i.e. those modules where they *have* a branch-group, and it's set to # be empty (""). my $resolver = $ctx->moduleBranchGroupResolver(); my $branchGroup = $ctx->effectiveBranchGroup(); @modules = grep { my $branch = $_->isKDEProject() ? $resolver->findModuleBranch($_->fullProjectPath(), $branchGroup) : 1; # Just a placeholder truthy value whisper ("Removing ", $_->fullProjectPath(), " due to branch-group") if (defined $branch and !$branch); (!defined $branch or $branch); # This is the actual test } (@modules); @modules = $self->_resolveModuleDependencies(@modules); # Filter --resume-foo options. This might be a second pass, but that should # be OK since there's nothing different going on from the first pass (in # resolveSelectorsIntoModules) in that event. @modules = _applyModuleFilters($ctx, @modules); return @modules; } # Causes kde-projects metadata to be downloaded (unless --pretend, --no-src, or # --no-metadata is in effect, although we'll download even in --pretend if # nothing is available). # # No return value. sub _downloadKDEProjectMetadata { my $self = shift; my $ctx = $self->context(); my $updateStillNeeded = 0; my $wasPretending = pretending(); eval { for my $metadataModule ( $ctx->getKDEDependenciesMetadataModule(), $ctx->getKDEProjectsMetadataModule()) { my $sourceDir = $metadataModule->getSourceDir(); super_mkdir($sourceDir); my $moduleSource = $metadataModule->fullpath('source'); my $updateDesired = !$ctx->getOption('no-metadata') && $ctx->phases()->has('update'); my $updateNeeded = (! -e $moduleSource) || is_dir_empty($moduleSource); my $lastUpdate = $ctx->getPersistentOption('global', 'last-metadata-update') // 0; $updateStillNeeded ||= $updateNeeded; if (!$updateDesired && $updateNeeded && (time - ($lastUpdate)) >= 7200) { warning (" r[b[*] Skipping build metadata update, but it hasn't been updated recently!"); } if ($updateNeeded && pretending()) { warning (" y[b[*] Ignoring y[b[--pretend] option to download required metadata\n" . " y[b[*] --pretend mode will resume after metadata is available."); ksb::Debug::setPretending(0); } if ($updateDesired && (!pretending() || $updateNeeded)) { $metadataModule->scm()->updateInternal(); $ctx->setPersistentOption('global', 'last-metadata-update', time); } ksb::Debug::setPretending($wasPretending); } }; my $err = $@; ksb::Debug::setPretending($wasPretending); if ($err) { die $err if $updateStillNeeded; # Assume previously-updated metadata will work if not updating warning (" b[r[*] Unable to download required metadata for build process"); warning (" b[r[*] Will attempt to press onward..."); warning (" b[r[*] Exception message: $@"); } } # Returns a list of Modules in the proper build order according to the # kde-build-metadata dependency information. # # The kde-build-metadata repository must have already been updated, and the # module factory must be setup. The Modules to reorder must be passed as # arguments. sub _resolveModuleDependencies { my $self = shift; my $ctx = $self->context(); my $metadataModule = $ctx->getKDEDependenciesMetadataModule(); my @modules = @_; @modules = eval { my $moduleResolver = $self->{module_resolver}; my $dependencyResolver = ksb::DependencyResolver->new(sub { # Maps module names (what dep resolver has) to built ksb::Modules # (which we need), needs to include all option handling (cmdline, # rc-file, module-sets, etc) return $moduleResolver->resolveModuleIfPresent(shift); }); my $branchGroup = $ctx->effectiveBranchGroup(); for my $file ('dependency-data-common', "dependency-data-$branchGroup") { my $dependencyFile = $metadataModule->fullpath('source') . "/$file"; my $dependencies = pretend_open($dependencyFile) or die "Unable to open $dependencyFile: $!"; debug (" -- Reading dependencies from $dependencyFile"); $dependencyResolver->readDependencyData($dependencies); close $dependencies; } my @reorderedModules = $dependencyResolver->resolveDependencies(@modules); return @reorderedModules; }; if ($@) { warning (" r[b[*] Problems encountered trying to sort modules into correct order:"); warning (" r[b[*] $@"); warning (" r[b[*] Will attempt to continue."); } return @modules; } # Similar to the old interactive runAllModulePhases. Actually performs the # build for the modules selected by setModulesToProcess. # # Returns a Mojo::Promise that must be waited on. The promise resolves to # return a single success/failure result; use the event handler for now to get # more detail during a build. sub startHeadlessBuild { my $self = shift; my $ctx = $self->context(); $ctx->statusMonitor()->createBuildPlan($ctx); my $promiseChain = ksb::PromiseChain->new; my $startPromise = Mojo::Promise->new; # These succeed or die outright $startPromise = _handle_updates ($ctx, $promiseChain, $startPromise); $startPromise = _handle_build ($ctx, $promiseChain, $startPromise); die "Can't obtain build lock" unless $ctx->takeLock(); # Install signal handlers to ensure that the lockfile gets closed. _installSignalHandlers(sub { note ("Signal received, terminating."); @main::atexit_subs = (); # Remove their finish, doin' it manually $self->finish(5); }); $startPromise->resolve; # allow build to start my $promise = $promiseChain->makePromiseChain($startPromise)->finally(sub { my @results = @_; my $result = 0; # success, non-zero is failure # Must use ! here to make '0 but true' hack work $result = 1 if defined first { !($_->[0] // 1) } @results; $ctx->statusMonitor()->markBuildDone(); $ctx->closeLock(); my $failedModules = join(',', map { "$_" } $ctx->listFailedModules()); if ($failedModules) { # We don't clear the list of failed modules on success so that # someone can build one or two modules and still use # --rebuild-failures $ctx->setPersistentOption('global', 'last-failed-module-list', $failedModules); } $ctx->storePersistentOptions(); _cleanup_log_directory($ctx); return $result; }); return $promise; } # Method: finish # # Exits the script cleanly, including removing any lock files created. # # Parameters: # ctx - Required; BuildContext to use. # [exit] - Optional; if passed, is used as the exit code, otherwise 0 is used. sub finish { my $self = shift; my $ctx = $self->context(); my $exitcode = shift // 0; if (pretending() || $self->{_base_pid} != $$) { # Abort early if pretending or if we're not the same process # that was started by the user (for async mode) exit $exitcode; } $ctx->closeLock(); $ctx->storePersistentOptions(); my $logdir = $ctx->getLogDir(); note ("Your logs are saved in y[$logdir]"); exit $exitcode; } ### Package-internal helper functions. # Reads a "line" from a file. This line is stripped of comments and extraneous # whitespace. Also, backslash-continued multiple lines are merged into a single # line. # # First parameter is the reference to the filehandle to read from. # Returns the text of the line. sub _readNextLogicalLine { my $fileReader = shift; while($_ = $fileReader->readLine()) { # Remove trailing newline chomp; # Replace \ followed by optional space at EOL and try again. if(s/\\\s*$//) { $_ .= $fileReader->readLine(); redo; } s/#.*$//; # Remove comments next if /^\s*$/; # Skip blank lines return $_; } return undef; } # Takes an input line, and extracts it into an option name, and simplified # value. The value has "false" converted to 0, white space simplified (like in # Qt), and tildes (~) in what appear to be path-like entries are converted to # the home directory path. # # First parameter is the build context (used for translating option values). # Second parameter is the line to split. # Return value is (option-name, option-value) sub _splitOptionAndValue { my $ctx = assert_isa(shift, 'ksb::BuildContext'); my $input = shift; my $optionRE = qr/\$\{([a-zA-Z0-9-]+)\}/; # The option is the first word, followed by the # flags on the rest of the line. The interpretation - # of the flags is dependant on the option. + # of the flags is dependent on the option. my ($option, $value) = ($input =~ /^\s* # Find all spaces ([-\w]+) # First match, alphanumeric, -, and _ # (?: ) means non-capturing group, so (.*) is $value # So, skip spaces and pick up the rest of the line. (?:\s+(.*))?$/x); $value //= ''; # Simplify whitespace. $value =~ s/\s+$//; $value =~ s/^\s+//; $value =~ s/\s+/ /g; # Check for false keyword and convert it to Perl false. $value = 0 if lc($value) eq 'false'; # Replace reference to global option with their value. # The regex basically just matches ${option-name}. my ($sub_var_name) = ($value =~ $optionRE); while ($sub_var_name) { my $sub_var_value = $ctx->getOption($sub_var_name) || ''; if(!$ctx->hasOption($sub_var_name)) { warning (" *\n * WARNING: $sub_var_name is not set at line y[$.]\n *"); ## TODO: filename is missing } debug ("Substituting \${$sub_var_name} with $sub_var_value"); $value =~ s/\$\{$sub_var_name\}/$sub_var_value/g; # Replace other references as well. Keep this RE up to date with # the other one. ($sub_var_name) = ($value =~ $optionRE); } # Replace tildes with home directory. 1 while ($value =~ s"(^|:|=)~/"$1$ENV{'HOME'}/"); return ($option, $value); } # Ensures that the given ModuleSet has at least a valid repository and # use-modules setting based on the given BuildContext. sub _validateModuleSet { my ($ctx, $moduleSet) = @_; my $name = $moduleSet->name() || 'unnamed'; my $rcSources = _getModuleSources($moduleSet); # re-read option from module set since it may be pre-set my $selectedRepo = $moduleSet->getOption('repository'); if (!$selectedRepo) { error (<getOption('git-repository-base'); if ($selectedRepo ne KDE_PROJECT_ID && not exists $repoSet->{$selectedRepo}) { my $projectID = KDE_PROJECT_ID; my $moduleSetName = $moduleSet->name(); my $moduleSetId = $moduleSetName ? "module-set ($moduleSetName)" : "module-set"; error (<isa('ksb::BuildContext') ? 'global' : $module->isa('ksb::ModuleSet') ? 'module-set' : $module->isa('ksb::Module') ? 'module' : 'options'; # Just look for an end marker if terminator not provided. $endRE //= qr/^end[\w\s]*$/; _markModuleSource($module, $fileReader->currentFilename() . ":$."); # Read in each option while (($_ = _readNextLogicalLine($fileReader)) && ($_ !~ $endRE)) { my $current_file = $fileReader->currentFilename(); # Sanity check, make sure the section is correctly terminated if(/^(module\b|options\b)/) { error ("Invalid configuration file $current_file at line $.\nAdd an 'end $endWord' before " . "starting a new module.\n"); die make_exception('Config', "Invalid file $current_file"); } my ($option, $value) = _splitOptionAndValue($ctx, $_); eval { $module->setOption($option, $value); }; if (my $err = $@) { if (blessed($err) && $err->isa('ksb::BuildException::Config')) { my $msg = "$current_file:$.: " . $err->message(); my $explanation = $err->optionUsageExplanation(); $msg = $msg . "\n" . $explanation if $explanation; $err->setMessage($msg); } die; # re-throw } } return $module; } # Marks the given OptionsBase subclass (i.e. Module or ModuleSet) as being # read in from the given string (filename:line). An OptionsBase can be # tagged under multiple files. sub _markModuleSource { my ($optionsBase, $configSource) = @_; my $key = '#defined-at'; my $sourcesRef = $optionsBase->hasOption($key) ? $optionsBase->getOption($key) : []; push @$sourcesRef, $configSource; $optionsBase->setOption($key, $sourcesRef); } # Returns rcfile sources for given OptionsBase (comma-separated). sub _getModuleSources { my $optionsBase = shift; my $key = '#defined-at'; my $sourcesRef = $optionsBase->getOption($key) || []; return join(', ', @$sourcesRef); } # Reads in a "moduleset". # # First parameter is the build context. # Second parameter is the filehandle to the config file to read from. # Third parameter is the ksb::ModuleSet to use. # # Returns the ksb::ModuleSet passed in with read-in options set, which may need # to be further expanded (see ksb::ModuleSet::convertToModules). sub _parseModuleSetOptions { my ($ctx, $fileReader, $moduleSet) = @_; $moduleSet = _parseModuleOptions($ctx, $fileReader, $moduleSet, qr/^end\s+module(-?set)?$/); if ($moduleSet->getOption('repository') eq KDE_PROJECT_ID && !$moduleSet->isa('ksb::ModuleSet::KDEProjects')) { # Perl-specific note! re-blessing the module set into the right 'class' # You'd probably have to construct an entirely new object and copy the # members over in other languages. bless $moduleSet, 'ksb::ModuleSet::KDEProjects'; } return $moduleSet; } # Function: _readConfigurationOptions # # Reads in the settings from the configuration, passed in as an open # filehandle. # # Phase: # initialization - Do not call from this function. # # Parameters: # ctx - The to update based on the configuration read and # any pending command-line options (see cmdlineGlobalOptions). # # filehandle - The I/O object to read from. Must handle _eof_ and _readline_ # methods (e.g. subclass). # # deferredOptions - An out parameter: a hashref holding the options set by any # 'options' blocks read in by this function. Each key (identified by the name # of the 'options' block) will point to a hashref value holding the options to # apply. # # Returns: -# @module - Heterogenous list of and defined in the +# @module - Heterogeneous list of and defined in the # configuration file. No module sets will have been expanded out (either # kde-projects or standard sets). # # Throws: # - Config exceptions. sub _readConfigurationOptions { my $ctx = assert_isa(shift, 'ksb::BuildContext'); my $fh = shift; my $deferredOptionsRef = shift; my @module_list; my $rcfile = $ctx->rcFile(); my ($option, %readModules); my $fileReader = ksb::RecursiveFH->new($rcfile); $fileReader->addFile($fh, $rcfile); # Read in global settings while ($_ = $fileReader->readLine()) { s/#.*$//; # Remove comments s/^\s*//; # Remove leading whitespace next if (/^\s*$/); # Skip blank lines # First command in .kdesrc-buildrc should be a global # options declaration, even if none are defined. if (not /^global\s*$/) { error ("Invalid configuration file: $rcfile."); error ("Expecting global settings section at b[r[line $.]!"); die make_exception('Config', 'Missing global section'); } # Now read in each global option. _parseModuleOptions($ctx, $fileReader, $ctx); last; } my $using_default = 1; my %seenModules; # NOTE! *not* module-sets, *just* modules. my %seenModuleSets; # and vice versa -- named sets only though! my %seenModuleSetItems; # To track option override modules. # Now read in module settings while ($_ = $fileReader->readLine()) { s/#.*$//; # Remove comments s/^\s*//; # Remove leading whitespace next if (/^\s*$/); # Skip blank lines # Get modulename (has dash, dots, slashes, or letters/numbers) my ($type, $modulename) = /^(options|module)\s+([-\/\.\w]+)\s*$/; my $newModule; # 'include' directives can change the current file, so check where we're at $rcfile = $fileReader->currentFilename(); # Module-set? if (not $modulename) { my $moduleSetRE = qr/^module-set\s*([-\/\.\w]+)?\s*$/; ($modulename) = m/$moduleSetRE/; # modulename may be blank -- use the regex directly to match if (not /$moduleSetRE/) { error ("Invalid configuration file $rcfile!"); error ("Expecting a start of module section at r[b[line $.]."); die make_exception('Config', 'Ungrouped/Unknown option'); } if ($modulename && exists $seenModuleSets{$modulename}) { error ("Duplicate module-set $modulename at $rcfile:$."); die make_exception('Config', "Duplicate module-set $modulename defined at $rcfile:$."); } if ($modulename && exists $seenModules{$modulename}) { error ("Name $modulename for module-set at $rcfile:$. is already in use on a module"); die make_exception('Config', "Can't re-use name $modulename for module-set defined at $rcfile:$."); } # A moduleset can give us more than one module to add. $newModule = _parseModuleSetOptions($ctx, $fileReader, ksb::ModuleSet->new($ctx, $modulename || "")); # Save 'use-modules' entries so we can see if later module decls # are overriding/overlaying their options. my @moduleSetItems = $newModule->moduleNamesToFind(); @seenModuleSetItems{@moduleSetItems} = ($newModule) x scalar @moduleSetItems; $seenModuleSets{$modulename} = $newModule if $modulename; } # Duplicate module entry? (Note, this must be checked before the check # below for 'options' sets) elsif (exists $seenModules{$modulename} && $type ne 'options') { error ("Duplicate module declaration b[r[$modulename] on line $. of $rcfile"); die make_exception('Config', "Duplicate module $modulename declared at $rcfile:$."); } # Module/module-set options overrides elsif ($type eq 'options') { my $options = _parseModuleOptions($ctx, $fileReader, ksb::OptionsBase->new()); $deferredOptionsRef->{$modulename} = $options->{options}; next; # Don't add to module list } # Must follow 'options' handling elsif (exists $seenModuleSets{$modulename}) { error ("Name $modulename for module at $rcfile:$. is already in use on a module-set"); die make_exception('Config', "Can't re-use name $modulename for module defined at $rcfile:$."); } else { $newModule = _parseModuleOptions($ctx, $fileReader, ksb::Module->new($ctx, $modulename)); $seenModules{$modulename} = $newModule; } push @module_list, $newModule; $using_default = 0; } while (my ($name, $moduleSet) = each %seenModuleSets) { _validateModuleSet($ctx, $moduleSet); } # If the user doesn't ask to build any modules, build a default set. # The good question is what exactly should be built, but oh well. if ($using_default) { warning (" b[y[*] There do not seem to be any modules to build in your configuration."); return (); } return @module_list; } # Exits out of kdesrc-build, executing the user's preferred shell instead. The # difference is that the environment variables should be as set in kdesrc-build # instead of as read from .bashrc and friends. # # You should pass in the options to run the program with as a list. # # Meant to implement the --run command line option. sub _executeCommandLineProgram { my ($program, @args) = @_; if (!$program) { error ("You need to specify a program with the --run option."); exit 1; # Can't use finish here. } if (($< != $>) && ($> == 0)) { error ("kdesrc-build will not run a program as root unless you really are root."); exit 1; } debug ("Executing b[r[$program] ", join(' ', @args)); exit 0 if pretending(); exec $program, @args or do { # If we get to here, that sucks, but don't continue. error ("Error executing $program: $!"); exit 1; }; } # Function: _split_url # # Subroutine to split a url into a protocol and host sub _split_url { my $url = shift; my ($proto, $host) = ($url =~ m|([^:]*)://([^/]*)/|); return ($proto, $host); } # Function: _check_for_ssh_agent # # Checks if we are supposed to use ssh agent by examining the environment, and # if so checks if ssh-agent has a list of identities. If it doesn't, we run # ssh-add (with no arguments) and inform the user. This can be controlled with # the disable-agent-check parameter. # # Parameters: # 1. Build context sub _check_for_ssh_agent { my $ctx = assert_isa(shift, 'ksb::BuildContext'); # Don't bother with all this if the user isn't even using SSH. return 1 if pretending(); my @svnServers = grep { $_->scmType() eq 'svn' } ($ctx->modulesInPhase('update')); my @gitServers = grep { $_->scmType() eq 'git' } ($ctx->modulesInPhase('update')); my @sshServers = grep { my ($proto, $host) = _split_url($_->getOption('svn-server')); # Check if ssh is explicitly used in the proto, or if the host is the # developer main svn. (defined $proto && $proto =~ /ssh/) || (defined $host && $host =~ /^svn\.kde\.org/); } @svnServers; push @sshServers, grep { # Check for git+ssh:// or git@git.kde.org:/path/etc. my $repo = $_->getOption('repository'); ($repo =~ /^git\+ssh:\/\//) || ($repo =~ /^[a-zA-Z0-9_.]+@.*:\//); } @gitServers; return 1 if (not @sshServers) or $ctx->getOption('disable-agent-check'); whisper ("\tChecking for SSH Agent") if (scalar @sshServers); # We're using ssh to download, see if ssh-agent is running. return 1 unless exists $ENV{'SSH_AGENT_PID'}; my $pid = $ENV{'SSH_AGENT_PID'}; # It's supposed to be running, let's see if there exists the program with # that pid (this check is linux-specific at the moment). if (-d "/proc" and not -e "/proc/$pid") { warning ("r[ *] SSH Agent is enabled, but y[doesn't seem to be running]."); warning ("Since SSH is used to download from Subversion you may want to see why"); warning ("SSH Agent is not working, or correct the environment variable settings."); return 0; } # The agent is running, but does it have any keys? We can't be more specific # with this check because we don't know what key is required. my $noKeys = 0; filter_program_output(sub { $noKeys ||= /no identities/ }, 'ssh-add', '-l'); if ($noKeys) { # Use print so user can't inadvertently keep us quiet about this. print ksb::Debug::colorize (<getOption('ssh-identity-file'); push (@commandLine, $identFile) if $identFile; my $result = system (@commandLine); if ($result) # Run this code for both death-by-signal and nonzero return { my $rcfile = $ctx->rcFile(); print "\nUnable to add SSH identity, aborting.\n"; print "If you don't want kdesrc-build to check in the future,\n"; print ksb::Debug::colorize ("Set the g[disable-agent-check] option to g[true] in your $rcfile.\n\n"); return 0; } } return 1; } # Function: _handle_updates # # Subroutine to update a list of modules. Uses a Mojolicious event loop # to run each update in a subprocess to avoid blocking the script. Only # one update process will exist at a given time. # # Parameters: # 1. Build Context, which will be used to determine the module update list. # 2. A PromiseChain for adding work items and dependencies. # 3. A "start promise" that can be waited on for pre-update steps. # # This function accounts for every module in $ctx's update phase. # # Returns an updated start promise and can also throw exception on error sub _handle_updates { my ($ctx, $promiseChain, $start_promise) = @_; my $kdesrc = $ctx->getSourceDir(); my @update_list = $ctx->modulesInPhase('update'); return $start_promise unless @update_list; croak_runtime("SSH agent is not running but should be") unless _check_for_ssh_agent($ctx); # TODO: Extract this to a setup function that all updates/build depend upon whisper ("Creating source directory") unless -e $kdesrc; croak_runtime ("Unable to make directory r[$kdesrc]! $!") if (! -e $kdesrc && !super_mkdir ($kdesrc)); for my $module (@update_list) { # sub must be defined here to capture $module in the loop my $updateSub = sub { return $module->runPhase_p('update', # called in child process, can block sub { return $module->update($ctx) }, # called in this process, with results sub { my (undef, $was_successful, $extras) = @_; $module->setOption('#numUpdates', $extras->{update_count}); return $was_successful; } ); }; $promiseChain->addItem("$module/update", "network-queue", $updateSub); } return $start_promise; } # Throws an exception if essential build programs are missing as a sanity check. sub _checkForEarlyBuildExit { my $ctx = shift; my @modules = $ctx->modulesInPhase('build'); # Check for absolutely essential programs now. if (!_checkForEssentialBuildPrograms($ctx) && !exists $ENV{KDESRC_BUILD_IGNORE_MISSING_PROGRAMS}) { error (" r[b[*] Aborting now to save a lot of wasted time."); error (" y[b[*] export KDESRC_BUILD_IGNORE_MISSING_PROGRAMS=1 and re-run (perhaps with --no-src)"); error (" r[b[*] to continue anyways. If this check was in error please report a bug against"); error (" y[b[*] kdesrc-build at https://bugs.kde.org/"); croak_runtime ("Essential build programs are missing!"); } } sub _openStatusFileHandle { my $ctx = shift; my $outfile = pretending() ? '/dev/null' : $ctx->getLogDir() . '/build-status'; my $statusFile; open $statusFile, '>', $outfile or do { error (<modulesInPhase('build'); my $result = 0; _checkForEarlyBuildExit($ctx); # exception-thrower my $num_modules = scalar @modules; my ($statusFile, $outfile) = _openStatusFileHandle($ctx); my $everFailed = 0; # This generates a bunch of subs but doesn't call them yet foreach my $module (@modules) { # Needs to happen in this loop to capture $module my $buildSub = sub { return if ($everFailed && $module->getOption('stop-on-failure')); my $fail_count = $module->getPersistentOption('failure-count') // 0; my $num_updates = int ($module->getOption('#numUpdates', 'module') // 1); # check for skipped updates, --no-src forces build-when-unchanged # even when ordinarily disabled if ($num_updates == 0 && !$module->getOption('build-when-unchanged') && $fail_count == 0) { # TODO: Why is the param order reversed for these two? $ctx->statusMonitor()->markPhaseStart("$module", 'build'); $ctx->markModulePhaseSucceeded('build', $module); return 'skipped'; } # Can't build w/out blocking so return a promise instead, which ->build # already supplies return $module->build()->catch(sub { my $failureReason = shift; if (!$everFailed) { # No failures yet, mark this as resume point $everFailed = 1; my $moduleList = join(', ', map { "$_" } ($module, @modules)); $ctx->setPersistentOption('global', 'resume-list', $moduleList); } ++$fail_count; # Force this promise chain to stay dead return Mojo::Promise->new->reject('build'); })->then(sub { $fail_count = 0; })->finally(sub { $module->setPersistentOption('failure-count', $fail_count); }); }; $promiseChain->addItem("$module/build", 'cpu-queue', $buildSub); # If there's an update phase we need to depend on it and show status if (my $updatePromise = $promiseChain->promiseFor("$module/update")) { $promiseChain->addDep("$module/build", "$module/update"); } }; # Add to the build 'queue' for promise chain so that this runs only after all # other build jobs $promiseChain->addDep('@postBuild', 'cpu-queue', sub { if ($statusFile) { close $statusFile; # Update the symlink in latest to point to this file. my $logdir = $ctx->getSubdirPath('log-dir'); if (-l "$logdir/latest/build-status") { safe_unlink("$logdir/latest/build-status"); } symlink($outfile, "$logdir/latest/build-status"); } return Mojo::Promise->new->reject if $everFailed; return 0; }); return $start_promise->then( sub { $ctx->unsetPersistentOption('global', 'resume-list') }); } # Function: _handle_async_build # # This subroutine special-cases the handling of the update and build phases, by # performing them concurrently using forked processes and non-blocking I/O. # See Mojo::Promise and Mojo::IOLoop::Subprocess # # This procedure will use multiple processes (the main process and separate # processes for each update or build as they occur). # # Parameters: # 1. Build Context to use, from which the module lists will be determined. # # Returns 0 on success, non-zero on failure. sub _handle_async_build { my ($ctx) = @_; my $result = 0; $ctx->statusMonitor()->createBuildPlan($ctx); my $promiseChain = ksb::PromiseChain->new; my $start_promise = Mojo::Promise->new; # These succeed or die outright eval { $start_promise = _handle_updates ($ctx, $promiseChain, $start_promise); $start_promise = _handle_build ($ctx, $promiseChain, $start_promise); }; if ($@) { error ("Caught an error $@ setting up to build"); return 1; } my $chain = $promiseChain->makePromiseChain($start_promise) ->finally(sub { # Fail if we had a zero-valued result (indicates error) my @results = @_; # Must use ! here to make '0 but true' hack work $result = 1 if defined first { !($_->[0] // 1) } @results; $ctx->statusMonitor()->markBuildDone(); }); # Start the update/build process $start_promise->resolve; Mojo::IOLoop->stop; # Force the wait below to block $chain->wait; return $result; } # Function: _handle_install # # Handles the installation process. Simply calls 'make install' in the build # directory, though there is also provision for cleaning the build directory # afterwards, or stopping immediately if there is a build failure (normally # every built module is attempted to be installed). # # Parameters: # 1. Build Context, from which the install list is generated. # # Return value is a shell-style success code (0 == success) sub _handle_install { my $ctx = assert_isa(shift, 'ksb::BuildContext'); my @modules = $ctx->modulesInPhase('install'); @modules = grep { $_->buildSystem()->needsInstalled() } (@modules); my $result = 0; for my $module (@modules) { $ctx->resetEnvironment(); $result = $module->install() || $result; if ($result && $module->getOption('stop-on-failure')) { note ("y[Stopping here]."); return 1; # Error } } return $result; } # Function: _handle_uninstall # # Handles the uninstal process. Simply calls 'make uninstall' in the build # directory, while assuming that Qt or CMake actually handles it. # # The order of the modules is often significant, and it may work better to # uninstall modules in reverse order from how they were installed. However this # code does not automatically reverse the order; modules are uninstalled in the # order determined by the build context. # # This function obeys the 'stop-on-failure' option supported by _handle_install. # # Parameters: # 1. Build Context, from which the uninstall list is generated. # # Return value is a shell-style success code (0 == success) sub _handle_uninstall { my $ctx = assert_isa(shift, 'ksb::BuildContext'); my @modules = $ctx->modulesInPhase('uninstall'); @modules = grep { $_->buildSystem()->needsInstalled() } (@modules); my $result = 0; for my $module (@modules) { $ctx->resetEnvironment(); $result = $module->uninstall() || $result; if ($result && $module->getOption('stop-on-failure')) { note ("y[Stopping here]."); return 1; # Error } } return $result; } # Function: _applyModuleFilters # # Applies any module-specific filtering that is necessary after reading command # line and rc-file options. (This is as opposed to phase filters, which leave # each module as-is but change the phases they operate as part of, this # function could remove a module entirely from the build). # # Used for --resume-{from,after} and --stop-{before,after}, but more could be # added in theory. # This subroutine supports --{resume,stop}-* for both modules and module-sets. # # Parameters: # ctx - in use. # @modules - List of or to apply filters on. # # Returns: # list of or with any inclusion/exclusion filters # applied. Do not assume this list will be a strict subset of the input list, # however the order will not change amongst the input modules. sub _applyModuleFilters { my $ctx = assert_isa(shift, 'ksb::BuildContext'); my @moduleList = @_; if (!$ctx->getOption('resume-from') && !$ctx->getOption('resume-after') && !$ctx->getOption('stop-before') && !$ctx->getOption('stop-after')) { debug ("No command-line filter seems to be present."); return @moduleList; } if ($ctx->getOption('resume-from') && $ctx->getOption('resume-after')) { # This one's an error. error (<getOption('stop-before') && $ctx->getOption('stop-after')) { # This one's an error. error (<getOption('resume-from') || $ctx->getOption('resume-after'); my $startIndex = scalar @moduleList; if ($resumePoint) { debug ("Looking for $resumePoint for --resume-* option"); # || 0 is a hack to force Boolean context. my $filterInclusive = $ctx->getOption('resume-from') || 0; my $found = 0; for (my $i = 0; $i < scalar @moduleList; $i++) { my $module = $moduleList[$i]; $found = $module->name() eq $resumePoint; if ($found) { $startIndex = $filterInclusive ? $i : $i + 1; $startIndex = min($startIndex, scalar @moduleList - 1); last; } } } else { $startIndex = 0; } my $stopPoint = $ctx->getOption('stop-before') || $ctx->getOption('stop-after'); my $stopIndex = 0; if ($stopPoint) { debug ("Looking for $stopPoint for --stop-* option"); # || 0 is a hack to force Boolean context. my $filterInclusive = $ctx->getOption('stop-before') || 0; my $found = 0; for (my $i = $startIndex; $i < scalar @moduleList; $i++) { my $module = $moduleList[$i]; $found = $module->name() eq $stopPoint; if ($found) { $stopIndex = $i - ($filterInclusive ? 1 : 0); last; } } } else { $stopIndex = scalar @moduleList - 1; } if ($startIndex > $stopIndex || scalar @moduleList == 0) { # Lost all modules somehow. croak_runtime("Unknown resume -> stop point $resumePoint -> $stopPoint."); } return @moduleList[$startIndex .. $stopIndex]; } # Updates the built-in phase list for all Modules passed into this function in # accordance with the options set by the user. sub _updateModulePhases { whisper ("Filtering out module phases."); for my $module (@_) { if ($module->getOption('manual-update') || $module->getOption('no-svn') || $module->getOption('no-src')) { $module->phases()->clear(); next; } if ($module->getOption('manual-build')) { $module->phases()->filterOutPhase('build'); $module->phases()->filterOutPhase('test'); $module->phases()->filterOutPhase('install'); } $module->phases()->filterOutPhase('install') unless $module->getOption('install-after-build'); $module->phases()->addPhase('test') if $module->getOption('run-tests'); } return @_; } # This subroutine extract the value from options of the form --option=value, # which can also be expressed as --option value. # # The first parameter is the option that the user passed to the cmd line (e.g. # --prefix=/opt/foo). # The second parameter is a reference to the list of command line options. # # The return value is the value of the option (the list of options might be # shorter by 1, copy it if you don't want it to change), or undef if no value # was provided. sub _extractOptionValue { my ($option, $options_ref) = @_; if ($option =~ /=/) { my @value = split(/=/, $option); shift @value; # We don't need the first one, that the --option part. return if (scalar @value == 0); # If we have more than one element left in @value it's because the # option itself has an = in it, make sure it goes back in the answer. return join('=', @value); } return if scalar @{$options_ref} == 0; return shift @{$options_ref}; } # Like _extractOptionValue, but throws an exception if the value is not # actually present, so you don't have to check for it yourself. If you do get a # return value, it will be defined to something. sub _extractOptionValueRequired { my ($option, $options_ref) = @_; my $returnValue = _extractOptionValue($option, $options_ref); if (not defined $returnValue) { croak_runtime("Option $option needs to be set to some value instead of left blank"); } return $returnValue; } # Function: _cleanup_log_directory # # This function removes log directories from old kdesrc-build runs. All log # directories not referenced by $log_dir/latest somehow are made to go away. # # Parameters: # 1. Build context. # # No return value. sub _cleanup_log_directory { my $ctx = assert_isa(shift, 'ksb::BuildContext'); my $logdir = $ctx->getSubdirPath('log-dir'); return 0 if ! -e "$logdir/latest"; # Could happen for error on first run... # This glob relies on the date being in the specific format YYYY-MM-DD-ID my @dirs = bsd_glob("$logdir/????-??-??-??/", GLOB_NOSORT); my @needed = _reachableModuleLogs("$logdir/latest"); # Convert a list to a hash lookup since Perl lacks a "list-has" my %needed_table; @needed_table{@needed} = (1) x @needed; for my $dir (@dirs) { my ($id) = ($dir =~ m/(\d\d\d\d-\d\d-\d\d-\d\d)/); safe_rmtree($dir) unless $needed_table{$id}; } } # Function: _output_failed_module_list # # Print out an error message, and a list of modules that match that error # message. It will also display the log file name if one can be determined. # The message will be displayed all in uppercase, with PACKAGES prepended, so # all you have to do is give a descriptive message of what this list of # packages failed at doing. # # No message is printed out if the list of failed modules is empty, so this # function can be called unconditionally. # # Parameters: # 1. Build Context # 2. Message to print (e.g. 'failed to foo') # 3. List of ksb::Modules that had failed to foo # # No return value. sub _output_failed_module_list { my ($ctx, $message, @fail_list) = @_; assert_isa($ctx, 'ksb::BuildContext'); $message = uc $message; # Be annoying if (@fail_list) { debug ("Message is $message"); debug ("\tfor ", join(', ', @fail_list)); } if (scalar @fail_list > 0) { my $homedir = $ENV{'HOME'}; my $logfile; warning ("\nr[b[<<< PACKAGES $message >>>]"); for my $module (@fail_list) { $logfile = $module->getOption('#error-log-file'); # async updates may cause us not to have a error log file stored # (though this should now only happen due to other bugs). Since # there's only one place it should be, take advantage of # side-effect of log_command() to find it. if (not $logfile) { my $logdir = $module->getLogDir() . "/error.log"; $logfile = $logdir if -e $logdir; } $logfile = "No log file" unless $logfile; $logfile =~ s|$homedir|~|; warning ("r[$module]") if pretending(); warning ("r[$module] - g[$logfile]") if not pretending(); } } } # Function: _output_failed_module_lists # # This subroutine reads the list of failed modules for each phase in the build # context and calls _output_failed_module_list for all the module failures. # # Parameters: # 1. Build context # # Return value: # None sub _output_failed_module_lists { my $ctx = assert_isa(shift, 'ksb::BuildContext'); # This list should correspond to the possible phase names (although # it doesn't yet since the old code didn't, TODO) for my $phase ($ctx->phases()->phases()) { my @failures = $ctx->failedModulesInPhase($phase); _output_failed_module_list($ctx, "failed to $phase", @failures); } # See if any modules fail continuously and warn specifically for them. my @super_fail = grep { ($_->getPersistentOption('failure-count') // 0) > 3 } (@{$ctx->moduleList()}); if (@super_fail) { warning ("\nThe following modules have failed to build 3 or more times in a row:"); warning ("\tr[b[$_]") foreach @super_fail; warning ("\nThere is probably a local error causing this kind of consistent failure, it"); warning ("is recommended to verify no issues on the system.\n"); } } # Function: _installTemplatedFile # # This function takes a given file and a build context, and installs it to a # given location while expanding out template entries within the source file. # # The template language is *extremely* simple: <% foo %> is replaced entirely # with the result of $ctx->getOption(foo, 'no-inherit'). If the result # evaluates false for any reason than an exception is thrown. No quoting of # any sort is used in the result, and there is no way to prevent expansion of # something that resembles the template format. # # Multiple template entries on a line will be replaced. # # The destination file will be created if it does not exist. If the file # already exists then an exception will be thrown. # # Error handling: Any errors will result in an exception being thrown. # # Parameters: # 1. Pathname to the source file (use absolute paths) # 2. Pathname to the destination file (use absolute paths) # 3. Build context to use for looking up template values # # Return value: There is no return value. sub _installTemplatedFile { my ($sourcePath, $destinationPath, $ctx) = @_; assert_isa($ctx, 'ksb::BuildContext'); open (my $input, '<', $sourcePath) or croak_runtime("Unable to open template source $sourcePath: $!"); open (my $output, '>', $destinationPath) or croak_runtime("Unable to open template output $destinationPath: $!"); while (!eof ($input)) { my $line = readline($input); if (!defined ($line)) { croak_runtime("Failed to read from $sourcePath at line $.: $!"); unlink($destinationPath); } # Some lines should only be present in the source as they aid with testing. next if $line =~ /kdesrc-build: filter/; $line =~ s { <% \s* # Template bracket and whitespace ([^\s%]+) # Capture variable name \s*%> # remaining whitespace and closing bracket } { $ctx->getOption($1, 'module') // croak_runtime("Invalid variable $1") }gxe; # Replace all matching expressions, use extended regexp w/ # comments, and replacement is Perl code to execute. (print $output $line) or croak_runtime("Unable to write line to $destinationPath at line $.: $!"); } } # Function: _installCustomFile # # This function installs a source file to a destination path, assuming the # source file is a "templated" source file (see also _installTemplatedFile), and # records a digest of the file actually installed. This function will overwrite # a destination if the destination is identical to the last-installed file. # # Error handling: Any errors will result in an exception being thrown. # # Parameters: # 1. Build context to use for looking up template values, # 2. The full path to the source file. # 3. The full path to the destination file (incl. name) # 4. The key name to use for searching/recording installed MD5 digest. # # Return value: There is no return value. sub _installCustomFile { use File::Copy qw(copy); my $ctx = assert_isa(shift, 'ksb::BuildContext'); my ($sourceFilePath, $destFilePath, $md5KeyName) = @_; my $baseName = basename($sourceFilePath); if (-e $destFilePath) { my $existingMD5 = $ctx->getPersistentOption('/digests', $md5KeyName) // ''; if (fileDigestMD5($destFilePath) ne $existingMD5) { if (!$ctx->getOption('#delete-my-settings')) { error ("\tr[*] Installing \"b[$baseName]\" would overwrite an existing file:"); error ("\tr[*] y[b[$destFilePath]"); error ("\tr[*] If this is acceptable, please delete the existing file and re-run,"); error ("\tr[*] or pass b[--delete-my-settings] and re-run."); return; } elsif (!pretending()) { copy ($destFilePath, "$destFilePath.kdesrc-build-backup"); } } } if (!pretending()) { _installTemplatedFile($sourceFilePath, $destFilePath, $ctx); $ctx->setPersistentOption('/digests', $md5KeyName, fileDigestMD5($destFilePath)); } } # Function: _installCustomSessionDriver # # This function installs the included sample .xsession and environment variable # setup files, and records the md5sum of the installed results. # # If a file already exists, then its md5sum is taken and if the same as what # was previously installed, is overwritten. If not the same, the original file # is left in place and the .xsession is instead installed to # .xsession-kdesrc-build # # Error handling: Any errors will result in an exception being thrown. # # Parameters: # 1. Build context to use for looking up template values, # # Return value: There is no return value. sub _installCustomSessionDriver { use FindBin qw($RealBin); use List::Util qw(first); use File::Copy qw(copy); my $ctx = assert_isa(shift, 'ksb::BuildContext'); my @xdgDataDirs = split(':', $ENV{XDG_DATA_DIRS} || '/usr/local/share/:/usr/share/'); my $xdgDataHome = $ENV{XDG_DATA_HOME} || "$ENV{HOME}/.local/share"; # First we have to find the source my @searchPaths = ($RealBin, map { "$_/apps/kdesrc-build" } ($xdgDataHome, @xdgDataDirs)); s{/+$}{} foreach @searchPaths; # Remove trailing slashes s{//+}{/}g foreach @searchPaths; # Remove duplicate slashes my $envScript = first { -f $_ } ( map { "$_/sample-kde-env-master.sh" } @searchPaths ); my $sessionScript = first { -f $_ } ( map { "$_/sample-xsession.sh" } @searchPaths ); if (!$envScript || !$sessionScript) { warning ("b[*] Unable to find helper files to setup a login session."); warning ("b[*] You will have to setup login yourself, or install kdesrc-build properly."); return; } my $destDir = $ENV{XDG_CONFIG_HOME} || "$ENV{HOME}/.config"; super_mkdir($destDir) unless -d $destDir; _installCustomFile($ctx, $envScript, "$destDir/kde-env-master.sh", 'kde-env-master-digest'); _installCustomFile($ctx, $sessionScript, "$ENV{HOME}/.xsession", 'xsession-digest') if $ctx->getOption('install-session-driver'); if (!pretending()) { if ($ctx->getOption('install-session-driver') && !chmod (0744, "$ENV{HOME}/.xsession")) { error ("\tb[r[*] Error making b[~/.xsession] executable: $!"); error ("\tb[r[*] If this file is not executable you may not be able to login!"); }; } } # Function: _checkForEssentialBuildPrograms # # This subroutine checks for programs which are absolutely essential to the # *build* process and returns false if they are not all present. Right now this # just means qmake and cmake (although this depends on what modules are # actually present in the build context). # # Parameters: # 1. Build context # # Return value: # None sub _checkForEssentialBuildPrograms { my $ctx = assert_isa(shift, 'ksb::BuildContext'); return 1 if pretending(); my @buildModules = $ctx->modulesInPhase('build'); my %requiredPrograms; my %modulesRequiringProgram; foreach my $module ($ctx->modulesInPhase('build')) { my @progs = $module->buildSystem()->requiredPrograms(); # Deliberately used @, since requiredPrograms can return a list. @requiredPrograms{@progs} = 1; foreach my $prog (@progs) { $modulesRequiringProgram{$prog} //= { }; $modulesRequiringProgram{$prog}->{$module->name()} = 1; } } my $wasError = 0; for my $prog (keys %requiredPrograms) { my %requiredPackages = ( qmake => 'Qt', cmake => 'CMake', ); my $programPath = absPathToExecutable($prog); # qmake is not necessarily named 'qmake' if (!$programPath && $prog eq 'qmake') { $programPath = ksb::BuildSystem::QMake::absPathToQMake(); } if (!$programPath) { # Don't complain about Qt if we're building it... if ($prog eq 'qmake' && ( grep { $_->buildSystemType() eq 'Qt' } (@buildModules)) || pretending() ) { next; } $wasError = 1; my $reqPackage = $requiredPackages{$prog} || $prog; my @modulesNeeding = keys %{$modulesRequiringProgram{$prog}}; local $, = ', '; # List separator in output error (<<"EOF"); Unable to find r[b[$prog]. This program is absolutely essential for building the modules: y[@modulesNeeding]. Please ensure the development packages for $reqPackage are installed by using your distribution's package manager. You can also see the https://techbase.kde.org/Getting_Started/Build/Distributions page for information specific to your distribution (although watch for outdated information :( ). EOF } } return !$wasError; } # Function: _reachableModuleLogs # # Returns a list of module directory IDs that must be kept due to being # referenced from the "latest" symlink. # # This function may call itself recursively if needed. # # Parameters: # 1. The log directory under which to search for symlinks, including the "/latest" # part of the path. sub _reachableModuleLogs { my $logdir = shift; my @dirs; # A lexicalized var (my $foo) is required in face of recursiveness. opendir(my $fh, $logdir) or croak_runtime("Can't opendir $logdir: $!"); my $dir = readdir($fh); while(defined $dir) { if (-l "$logdir/$dir") { my $link = readlink("$logdir/$dir"); push @dirs, $link; } elsif ($dir !~ /^\.{1,2}$/) { # Skip . and .. directories (this is a great idea, trust me) push @dirs, _reachableModuleLogs("$logdir/$dir"); } $dir = readdir $fh; } closedir $fh; # Extract numeric IDs from directory names. @dirs = map { m/(\d{4}-\d\d-\d\d-\d\d)/ } (@dirs); # Convert to unique list by abusing hash keys. my %tempHash; @tempHash{@dirs} = (); return keys %tempHash; } # Installs the given subroutine as a signal handler for a set of signals which # could kill the program. # # First parameter is a reference to the sub to act as the handler. sub _installSignalHandlers { my $handlerRef = shift; my @signals = qw/HUP INT QUIT ABRT TERM PIPE/; @SIG{@signals} = ($handlerRef) x scalar @signals; } +# Ensures that basic one-time setup to actually *use* installed software is +# performed, including .kdesrc-buildrc setup if necessary. +# +# Returns the appropriate exitcode to pass to the exit function +sub performInitialUserSetup +{ + my $self = shift; + return ksb::FirstRun::setupUserSystem(); +} + # Shows a help message and version. Does not exit. sub _showHelpMessage { my $scriptVersion = scriptVersion(); - print < and others, and is +distributed under the terms of the GNU GPL v2. This script automates the download, build, and install process for KDE software using the latest available source code. -You should first setup a configuration file (~/.kdesrc-buildrc). You can do -this by running the kdesrc-build-setup program, which should be included with -this one. You can also copy the kdesrc-buildrc-sample file (which should be -included) to ~/.kdesrc-buildrc. - -Basic synopsis, after setting up .kdesrc-buildrc: -\$ $0 [--options] [module names] - -The module names can be either the name of an individual module (as set in your -configuration with a module declaration, or a use-modules declaration), or of a -module set (as set with a module-set declaration). - -If you don\'t specify any particular module names, then every module you have -listed in your configuration will be built, in the order listed. - -Copyright (c) 2003 - 2018 Michael Pyne , and others. +Configuration is controlled from "\$PWD/kdesrc-buildrc" or "~/.kdesrc-buildrc". +See kdesrc-buildrc-sample for an example. -The script is distributed under the terms of the GNU General Public License -v2, and includes ABSOLUTELY NO WARRANTY!!! +Usage: \$ $0 [--options] [module names] + All configured modules are built if none are listed. -Options: - --no-src Skip contacting the source server. - --no-build Skip the build process. - --no-install Don't automatically install after build. +Important Options: + --pretend Don't actually take major actions, instead describe + what would be done. + --no-src Don't update source code, just build/install. + --src-only Only update the source code + --refresh-build Start the build from scratch. - --pretend Don't actually take major actions, instead describe - what would be done. + --rc-file= Read configuration from filename instead of default. + --initial-setup Installs Plasma env vars (~/.bashrc), required + system pkgs, and a base kdesrc-buildrc. - --src-only Only update the source code (Identical to --no-build - at this point). - --build-only Build only, don't perform updates or install. + --resume-from= Skips modules until just before or after the given + --resume-after= package, then operates as normal. + --stop-before= Stops just before or after the given package is + --stop-after= reached. - --install-only Only install the already compiled code, this is equivalent - --install to make install/fast in CMake. Useful for example when we - want to clean the install directory but we do not want to - re-compile everything. + --include-dependencies Also builds KDE-based dependencies of given modules. + --stop-on-failure Stops the build as soon as a package fails to build. - --rc-file= Read configuration from filename instead of default. - - --resume-from= Skips modules until just before the given package, - then operates as normal. - --resume-after= Skips modules up to and including the given package, - then operates as normal. - - --stop-before= Skips the given package and all later packages. - --stop-after= Skips all packages after the given package. - --stop-on-failure Stops the build as soon as a package fails to build. - - --reconfigure Run CMake/configure again, but don't clean the build - directory. - --build-system-only Create the build infrastructure, but don't actually - perform the build. - - --