[sdk/kdesrc-build/docbook_historied_per_file] doc: Merge kdesrc-build doc updates from svn.
Git commit 6c0bf1b29e0a9d7bebd9b7cc56fa8d20b6d6dae9 by Michael Pyne. Committed on 30/01/2011 at 03:05. Pushed by ashark into branch 'docbook_historied_per_file'. Merge kdesrc-build doc updates from svn. Awhile ago I started a subversion work branch so that I could continue to update the Docbook docs for kdesrc-build. Now that kdesrc-build is out of the SC (and the freeze is up anyways) I can merge the changes/fixes back in. Original commit: d066e357 https://invent.kde.org/sdk/kdesrc-build/-/commit/d066e3572f21e18f57b88eb51590d231c251c4fb M +5-4doc/getting-started/before-building.docbook M +55 -12 doc/getting-started/building-and-troubleshooting.docbook M +4-20 doc/getting-started/configure-data.docbook M +2-0doc/getting-started/index.docbook A +179 -0doc/getting-started/kde-modules-and-selection.docbook M +3-2doc/index.docbook M +1-1doc/introduction/index.docbook M +94 -1doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/6c0bf1b29e0a9d7bebd9b7cc56fa8d20b6d6dae9 diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook index 5d26642c..2f2026e4 100644 --- a/doc/getting-started/before-building.docbook +++ b/doc/getting-started/before-building.docbook @@ -50,10 +50,11 @@ should be set to go. If you are building or any of the various modules that are available from http://gitorious.org/;>Gitorious -then you will need the http://gitscm.org/;>Git source control -manager installed as well. +(for ) or 's http://projects.kde.org/;>git-based +projects then you will need the http://gitscm.org/;>Git +source control manager installed as well. -You will need a C++ development environment. GCC 3.4 or +You will need a C++ development environment. GCC 4.1 or later is recommended. @@ -86,7 +87,7 @@ to use the copy, you need to do these things: If you do not already have installed, install it, including any relevant -dev or -devel packages. You will need at least - 4.6 if you are building 4. + 4.7 if you are building 4. diff --git a/doc/getting-started/building-and-troubleshooting.docbook b/doc/getting-started/building-and-troubleshooting.docbook index d414d44a..b1e2a2e6 100644 --- a/doc/getting-started/building-and-troubleshooting.docbook +++ b/doc/getting-started/building-and-troubleshooting.docbook @@ -6,14 +6,43 @@ Now you are ready to run the script. From a terminal window, log in to the user you are using to compile and execute the script: -$kdesrc-build + kdesrc-build +Afterwards, you should see output similar to that in : + + +Example output of building a single module + + kdesrc-build kdelibs +Script started processing at Wed Dec 22 13:21:45 2010 + Build Process +Building kdelibs (1/1) +Waiting for source code update. +Source update complete for kdelibs: 48 files affected. +Checking for source conflicts... +Compiling... +Build succeeded after 13 minutes, and 6 seconds. +Installing kdelibs. +Overall time for kdelibs was 13 minutes, and 53 seconds. + + Build Done + + PACKAGES SUCCESSFULLY BUILT +kdelibs + +Script finished processing at Wed Dec 22 13:35:38 2010 +Your logs are saved in /home/kde-src/log-kdesrc-build/2010-12-22-01 + + + -Now, the script should start downloading the sources and compiling them. Depending on -how many modules you are downloading, it is possible that -will not succeed the first time you compile . Do not despair! +At this point, should start downloading the sources and +compiling them. Depending on how many modules you are downloading, it is +possible that will not succeed the first time you compile . +Do not despair! logs the output of every command it runs. By default, @@ -21,18 +50,28 @@ the log files are kept in ~/kdesrc/log. T the caused an error for a module in the last 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, and pass the --reconfigure option after installing the -missing packages. +before trying to build that module again. Make sure that when you run + again to pass the --reconfigure option so that + forces the module to check for the missing packages +again. -Or, if the error appears to be a build error then it is probably an error -with the
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Add a --print-modules command line option.
Git commit a1a3089ddaa94f48a3910f2a94d3c89d34192054 by Michael Pyne. Committed on 06/02/2014 at 05:20. Pushed by ashark into branch 'docbook_historied_per_file'. Add a --print-modules command line option. Does about what it sounds like, but quicker. Useful for checking to see what kdesrc-build is resolving module dependencies to. The beginning output is intermixed but you can grep for "* Module list" if you want and everything after will be module names. Original commit: 6c49f524 https://invent.kde.org/sdk/kdesrc-build/-/commit/6c49f52422fcc4c09960b8aaa36375d652c6c531 M +30 -0doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/a1a3089ddaa94f48a3910f2a94d3c89d34192054 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index c5b53460..e4981cc0 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -296,6 +296,36 @@ 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 +--pretend or --no-src). + + +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 +understands a module's dependencies to be, which means it's only useful for +kde-projects +modules. This option is also compatible with --resume-from, --resume-after, +--stop-before, +--stop-after. + + + --run
[sdk/kdesrc-build/docbook_historied_per_file] doc: Eliminate distinction between `prefix` and `install-dir`
Git commit 3d5459c7177e61a10e243789922e0dc885b45e98 by Andrew Shark.
Committed on 14/01/2024 at 01:38.
Pushed by ashark into branch 'docbook_historied_per_file'.
Eliminate distinction between `prefix` and `install-dir`
We will not use `--prefix` cli option or `prefix` config option anymore,
because it means same thing what `install-dir` was meant for.
- For those who used '$MODULE' or '${MODULE}' in the `prefix` config option, we
now will make that substitution in `install-dir` config option.
- Add a warning message if the prefix config option still found in user config
Closes #141
Original commit: 9b8ccbfe
https://invent.kde.org/sdk/kdesrc-build/-/commit/9b8ccbfe26bc751f42df49b2dc15f4a1ea886480
M +3-4doc/cmdline/supported-cmdline-params.docbook
M +7-17 doc/kdesrc-buildrc/conf-options-table.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/3d5459c7177e61a10e243789922e0dc885b45e98
diff --git a/doc/cmdline/supported-cmdline-params.docbook
b/doc/cmdline/supported-cmdline-params.docbook
index ab7923bc..71993bdc 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -526,11 +526,10 @@
linkend="cmdline-refresh-build">--refresh-build is used.
-
---prefix /path/to/kde
+
+--install-dir path
-This allows you to change the directory that will be installed to from
-the command line. This option implies --reconfigure,
but using --refresh-build
may still be required.
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook
b/doc/kdesrc-buildrc/conf-options-table.docbook
index e74858b1..86e35dbb 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -791,11 +791,17 @@ flag.
TypeString
Default value~/kde/usr
-This option sets the directory that will be installed to after it
+This option controls where to install the module after it
is built. If you
change this to a directory needing root access, you may want to read about the
make-install-prefix option as
well.
+
+Changing this option for specific module allows you to install it to a
different directory than
+where the Platform libraries are installed, such as if you were using
+ only to build applications.
+You can use ${MODULE} or $MODULE
+in the path to have them expanded to the module's name.
@@ -1001,22 +1007,6 @@ the auto-detection. In this case you can manually
specify the correct build type
-
-prefix
-
-
-TypeString
-
-This option controls where to install the module (normally the
-install-dir 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
- 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
[sdk/kdesrc-build/docbook_historied_per_file] doc: Rename kdesvn-build to kdesrc-build in the trunk documentation. It installs and
Git commit 010de2f968236e412edee54daf6d2b6b46762986 by Michael Pyne. Committed on 23/08/2010 at 01:36. Pushed by ashark into branch 'docbook_historied_per_file'. Rename kdesvn-build to kdesrc-build in the trunk documentation. It installs and views fine here so I'm pretty sure I've done this correctly, but just let me know if I've left something out. I intend to rename the KDE 4.5 docs as well if permitted by the translations (as urged by Burkhard Lück), this would occur shortly after tagging 4.5.1. I will mail separately about this permission. CCMAIL:kde-i18n-...@kde.org svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=1166825 Original commit: 5329efbe https://invent.kde.org/sdk/kdesrc-build/-/commit/5329efbe107a530e645158fe2e21113713a6aa29 M +20 -20 doc/cmdline/supported-cmdline-params.docbook M +1-1doc/cmdline/supported-envvars.docbook M +22 -22 doc/features/features-overview.docbook M +1-1doc/features/index.docbook R +16 -16 doc/features/kdesrc-build-logging.docbook [from: doc/features/kdesvn-build-logging.docbook - 076% similarity] M +23 -23 doc/getting-started/before-building.docbook M +7-7doc/getting-started/building-and-troubleshooting.docbook M +10 -10 doc/getting-started/configure-data.docbook M +2-2doc/getting-started/environment.docbook M +1-1doc/getting-started/index.docbook M +19 -16 doc/index.docbook M +6-3doc/introduction/index.docbook M +2-2doc/kde-cmake/kde-cmake-intro.docbook R +23 -23 doc/kdesrc-buildrc/conf-options-table.docbook [from: doc/kdesvn-buildrc/conf-options-table.docbook - 094% similarity] A +6-0doc/kdesrc-buildrc/index.docbook R +5-5doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook [from: doc/kdesvn-buildrc/kdesvn-buildrc-overview.docbook - 094% similarity] D +0-6doc/kdesvn-buildrc/index.docbook R +41 -41 doc/using-kdesrc-build/advanced-features.docbook [from: doc/using-kdesvn-build/advanced-features.docbook - 085% similarity] R +24 -24 doc/using-kdesrc-build/basic-features.docbook [from: doc/using-kdesvn-build/basic-features.docbook - 083% similarity] R +4-4doc/using-kdesrc-build/developer-features.docbook [from: doc/using-kdesvn-build/developer-features.docbook - 078% similarity] A +14 -0doc/using-kdesrc-build/index.docbook R +24 -24 doc/using-kdesrc-build/other-features.docbook [from: doc/using-kdesvn-build/other-features.docbook - 083% similarity] A +17 -0doc/using-kdesrc-build/using-kdesrc-build-preface.docbook D +0-14 doc/using-kdesvn-build/index.docbook D +0-17 doc/using-kdesvn-build/using-kdesvn-build-preface.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/010de2f968236e412edee54daf6d2b6b46762986 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index f068282f..84096a9a 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -49,9 +49,9 @@ Enable colorful output. (This is the default for interactive terminals). --nice=value -This value adjusts the computer CPU priority requested by , and +This value adjusts the computer CPU priority requested by , and should be in the range of 0-20. 0 is highest priority (because it is the -least nice), 20 is lowest priority. defaults +least nice), 20 is lowest priority. defaults to 10. @@ -62,7 +62,7 @@ to 10. Disables the asynchronous mode of updating. Instead the update will be performed in its entirety before the build starts. This option will slow down the overall process, but if you encounter IPC errors -while running try using this option, and submitting a +while running try using this option, and submitting a http://bugs.kde.org/;>bug report. @@ -77,7 +77,7 @@ Disable colorful output. --pretend (or -p) - will run through the update and build process, but instead of + 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.). @@ -106,7 +106,7 @@ Only output warnings and errors. --verbose (or -v) -Be very descriptive about what is going on, and what is doing. +Be very descriptive about what is going on, and what is doing. @@ -172,7 +172,7 @@ doing in debugging mode. --no-rebuild-on-fail Do not try to -rebuild modules that have failed building from scratch. will +rebuild modules that have failed building from scratch. will never try to do this to a module that already was tried to be built from scratch. @@ -190,7 +190,7 @@ Recreate the build system and make from scratch. Run cmake (for modules) or configure (for ) again, without cleaning the build -directory. You should not normally have to specify this, as will +directory. You should not normally have to specify this, as will detect
[sdk/kdesrc-build/docbook_historied_per_file] doc/using-kdesvn-build: change obsolete branch 3.3 to 4.4, git for qt-copy is still missing, but at least everything is for kde4
Git commit 4d1376d43f905eff6b59e5a8af3fcba301a474fe by Burkhard Lück. Committed on 27/05/2010 at 04:54. Pushed by ashark into branch 'docbook_historied_per_file'. change obsolete branch 3.3 to 4.4, git for qt-copy is still missing, but at least everything is for kde4 CCMAIL:mp...@kde.org svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=1131050 Original commit: 08f7893d https://invent.kde.org/sdk/kdesrc-build/-/commit/08f7893d82d4a29a1b73b5b94c515abf1a81c624 M +8-8doc/using-kdesvn-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/4d1376d43f905eff6b59e5a8af3fcba301a474fe diff --git a/doc/using-kdesvn-build/advanced-features.docbook b/doc/using-kdesvn-build/advanced-features.docbook index 79fef174..0b35d3bf 100644 --- a/doc/using-kdesvn-build/advanced-features.docbook +++ b/doc/using-kdesvn-build/advanced-features.docbook @@ -21,7 +21,7 @@ option for a module, which will specify a list of directories to download. If you do not already know what to download from a module, it may be a good idea to browse the layout for a module first, using -http://websvn.kde.org/branches/KDE/3.5/;>WebSVN. +http://websvn.kde.org/branches/KDE/4.4/;>WebSVN. @@ -136,21 +136,21 @@ and will try to determine the appropriate location within the well. -To download kdelibs from 3.5 (which is simply known as the 3.5 branch): +To download kdelibs from 4.4 (which is simply known as the 4.4 branch): module kdelibs - branch 3.5 + branch 4.4 # other options... end module -Or, to download kdemultimedia as it was released with 3.4.3: +Or, to download kdemultimedia as it was released with 4.4.3: module kdemultimedia - tag 3.4.3 + tag 4.4.3 # other options... end module @@ -182,12 +182,12 @@ can figure out the appropriate middle part by itself. When it cannot, you can us module qt-copy # branch does not work here yet - module-base-path branches/qt/3.3 + module-base-path branches/qt/4.4 end module This would cause to download qt-copy from (in this example), -svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy. +svn://anonsvn.kde.org/home/kde/branches/qt/4.4/qt-copy. @@ -201,7 +201,7 @@ paths that would have no hope of downloading from. module qt-copy # Specify exact path to grab. - override-url svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy + override-url svn://anonsvn.kde.org/home/kde/branches/qt/4.4/qt-copy end module
[sdk/kdesrc-build/docbook_historied_per_file] doc: kde-projects: Don't auto-filter git-repo's direct children.
Git commit 26461b97d3f53c09024bc602ddaca3c904a3b043 by Michael Pyne. Committed on 12/07/2013 at 03:41. Pushed by ashark into branch 'docbook_historied_per_file'. kde-projects: Don't auto-filter git-repo's direct children. Kind of a mouthful, but remove a filter that was added to avoid automatically including an actual git repository's children that were also git repositories. E.g. think of something like a SuperBuild git module that also had its component git modules as logical children within projects.kde.org. This filter is unnecessary now that kdesrc-build supports both kde.org metadata (kde-build-metadata/build-script-ignore) and user-configurable module filtering (ignore-modules option). More importantly this filter precludes many other desirable types of group syntax (e.g. including all of kdebindings just by asking for kdebindings). So we remove the filter. The trouble I've seen so far is that it is now rather difficult to build *only* kdelibs, since kde/kdelibs is a logical parent of nepomuk-core, nepomuk-widgets, and kactivities. This can be worked-around by using a normal single module declaration. E.g. module kdelibs repository kde:kdelibs end module On the other hand, the recently-added config file option "ignore-modules" should now remove any kde-projects modules that contain a path component(s) matching the ignored module. You may have to be specific with a given ignore atom for this reason (e.g. ignore playground/libs, not 'libs' otherwise you'll also ignore kdegraphics/libs at this point... though that was also true before this commit). BUG:321667 Original commit: a0338664 https://invent.kde.org/sdk/kdesrc-build/-/commit/a033866429b62c29fd93aea843c2f21427634ec8 M +12 -0doc/getting-started/kde-modules-and-selection.docbook M +12 -0doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/26461b97d3f53c09024bc602ddaca3c904a3b043 diff --git a/doc/getting-started/kde-modules-and-selection.docbook b/doc/getting-started/kde-modules-and-selection.docbook index 7af9af7f..eedcd576 100644 --- a/doc/getting-started/kde-modules-and-selection.docbook +++ b/doc/getting-started/kde-modules-and-selection.docbook @@ -326,6 +326,18 @@ module-set utils # This option "subtracts out" modules from the modules chosen by use-modules, above. ignore-modules kremotecontrol end module-set + +module-set graphics +repository kde-projects + +# This option chooses what modules to look for in the database. +use-modules 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 +ignore-modules extragear/graphics/kipi-plugins +end module-set diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index c7e6ffdb..c7279992 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -434,6 +434,18 @@ 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 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 1.16.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Add --stop-{before,after} command line options.
Git commit b109e05d3eb833c384114cb07856a51099f29416 by Michael Pyne.
Committed on 20/02/2013 at 04:23.
Pushed by ashark into branch 'docbook_historied_per_file'.
Add --stop-{before,after} command line options.
Should hopefully be pretty much what it says on the tin. Stop either
right before or right after the given module. (GUI flag since this
involves documentation changes to the Handbook and man page).
BUG:315251
FIXED-IN:1.16
GUI:
Original commit: f3d30fb5
https://invent.kde.org/sdk/kdesrc-build/-/commit/f3d30fb5a056f297181aa63d66af5f92f45b2635
M +30 -0doc/cmdline/supported-cmdline-params.docbook
M +4-3doc/index.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/b109e05d3eb833c384114cb07856a51099f29416
diff --git a/doc/cmdline/supported-cmdline-params.docbook
b/doc/cmdline/supported-cmdline-params.docbook
index cc2498ba..346c495f 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -255,6 +255,36 @@ yourself, and want to start again with the
next
module.
+
+--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 --stop-before=moduleB would
cause
+ to only build moduleA.
+
+This command line option was added with 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 --stop-after=moduleB would
cause
+ to build moduleA and
moduleB.
+
+This command line option was added with 1.16.
+
+
+
--rc-file
diff --git a/doc/index.docbook b/doc/index.docbook
index 934ab40c..54285e39 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -2,7 +2,7 @@
+Copyright (c) 2005-2008, 2010-2013 Michael Pyne
Copyright (c) 2005 Carlos Leonhard Woelz
Copyright (c) 2009 Burkhard Lück
@@ -129,6 +129,7 @@
2010
2011
2012
+2013
Michael Pyne
@@ -139,8 +140,8 @@
-2012-05-05
-1.15
+2013-02-19
+1.16
is a script which builds and installs software
[sdk/kdesrc-build/docbook_historied_per_file] doc: Some more improvements/corrections
Git commit e1a72f39bb8fbbfa019b400a6299355d29f93b87 by Federico Zenith. Committed on 10/11/2007 at 10:10. Pushed by ashark into branch 'docbook_historied_per_file'. Some more improvements/corrections CCMAIL: michael.p...@kdemail.net svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=734875 Original commit: b064c0a6 https://invent.kde.org/sdk/kdesrc-build/-/commit/b064c0a69cf0857da0df41f1e8fc78e1de554562 M +27 -28 doc/cmdline/index.docbook M +4-4doc/features/features-overview.docbook M +7-7doc/features/kdesvn-build-logging.docbook M +12 -12 doc/getting-started/before-building.docbook M +4-4doc/getting-started/building-and-troubleshooting.docbook M +4-3doc/getting-started/configure-data.docbook M +2-2doc/getting-started/environment.docbook M +1-0doc/index.docbook M +1-1doc/kde-cmake/kde-cmake-intro.docbook M +47 -46 doc/kdesvn-buildrc/index.docbook M +20 -20 doc/using-kdesvn-build/advanced-features.docbook M +7-7doc/using-kdesvn-build/basic-features.docbook M +2-2doc/using-kdesvn-build/developer-features.docbook M +4-4doc/using-kdesvn-build/other-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/e1a72f39bb8fbbfa019b400a6299355d29f93b87 diff --git a/doc/cmdline/index.docbook b/doc/cmdline/index.docbook index f2d575d0..469a0032 100644 --- a/doc/cmdline/index.docbook +++ b/doc/cmdline/index.docbook @@ -2,7 +2,7 @@ Command Line Options and Environment Variables -This script doesn't use environment variables. If you need to set environment +This script does not use environment variables. If you need to set environment variables for the build or install process, please see the set-env option. @@ -16,21 +16,21 @@ The script accepts the following command-line options: --help -only display simple help on this script. +Only display simple help on this script. --version -display the program version. +Display the program version. --author -display contact information for the +Display contact information for the author. @@ -38,7 +38,7 @@ author. --color -enable colorful output. +Enable colorful output. @@ -53,21 +53,21 @@ of this run. value should be between 0 and 20. --no-color -disable colorful output. +Disable colorful output. --pretend (or -p) -don't actually DO anything, but act like you did. +Do not actually do anything, but act like you did. --quiet (or -q) -Don't be as noisy with the output. With this switch only the basics are +Do not be as noisy with the output. With this switch only the basics are output. @@ -82,28 +82,28 @@ Only output warnings and errors. --verbose -Be very descriptive about what's going on, and what is doing. +Be very descriptive about what is going on, and what is doing. --svn-only -only perform the source update. +Only perform the source update. --build-only -only perform the build process. +Only perform the build process. --ignore-modules -don't include the modules passed on the rest of the command line in the update/build +Do not include the modules passed on the rest of the command line in the update/build process. @@ -111,38 +111,38 @@ process. --no-svn -skip contacting the server. +Skip contacting the server. --no-build -skip the build process. +Skip the build process. --no-install -don't automatically install packages after they're built. +Do not automatically install packages after they are built. --debug -enables debug mode for the script. Currently -this means that all output will be dumped to STDOUT in addition to being +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're doing in debugging mode. +verbose about what they are doing in debugging mode. --no-rebuild-on-fail -don't try and +Do not try to rebuild modules that have failed building from scratch. will never try to do this to a module that already was tried to be built from scratch. @@ -152,22 +152,21 @@ scratch. --refresh-build -recreate the build system and make from scratch. +Recreate the build system and make from scratch. --reconfigure -run the configure script again -without cleaning the build directory. +Run the configure script again without cleaning the build directory. --recreate-configure -run make -f +Run make -f Makefile.cvs again to create the configure script, and continue building as normal. This option implies --reconfigure. @@ -209,7 +208,7 @@ the environment variables (such as PATH and --prefix=/path/to/kde -which allows you to change the directory that will be installed to from the command line. +This allows you to change the directory that will be
[sdk/kdesrc-build/docbook_historied_per_file] doc: doc: Document the branch-group option.
Git commit 99b7e74dae9bfa70190cac96de61c44452bc65ce by Michael Pyne. Committed on 12/08/2013 at 19:45. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Document the branch-group option. Original commit: d966b820 https://invent.kde.org/sdk/kdesrc-build/-/commit/d966b820a52f045f926653bdf951fbaa6ea84987 M +66 -0doc/appendix-modules/module-concept.docbook M +64 -3doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/99b7e74dae9bfa70190cac96de61c44452bc65ce diff --git a/doc/appendix-modules/module-concept.docbook b/doc/appendix-modules/module-concept.docbook index b223fe0a..47ec9dc5 100644 --- a/doc/appendix-modules/module-concept.docbook +++ b/doc/appendix-modules/module-concept.docbook @@ -59,4 +59,70 @@ in this case) empty if you like. This repository setting tells automatically include any Git modules that are grouped under the modules you list (in the KDE Project database). + + +Module branch groups + +Taking the concept of a group of +modules further, the 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 Frameworks for 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. + + + 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 +branch-group kf5-qt5 + +# Other global options here ... +end global + +module-set +# branch-group only works for kde-projects +repository kde-projects + +# branch-group is inherited from the one set globally, but could +# specified here. + +use-modules 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 developers in a Git +repository named kde-build-metadata, however this module +will be included automatically by (though you may see it appear +in the script output). + + + 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. + + + + diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index c7279992..1b9a7701 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -80,15 +80,76 @@ 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 instead of the -default of trunk, where development occurs. +default of master (for modules) or +trunk (for ), where development +occurs. + + For instance, to checkout 4.6 branch, you would set this option to 4.6. + If fails to properly download a branch with this option, you may have to manually specify the to download from using the module-base-path or override-url options. -Note: This option also works with source modules that use - instead of . + +For most 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 module types, will determine the +actual branch to use automatically based on rules encoded by the +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 + 4-based libraries and applications. + +latest-qt4, for tracking development and new +features for the 4-based libraries and +applications. + +kf5-qt5, for tracking +bleeding-edge development for the upcoming 5-based +Frameworks 5, Workspace 2, + + + +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 1.16-pre2. + +This option only applies to kde-projects +modules (the common case). See also . + +
[sdk/kdesrc-build/docbook_historied_per_file] doc/introduction: Remove extra dots after entity
Git commit 97258efb3e18ca3d8b70d4b36425ba0bc9c94114 by Burkhard Lück. Committed on 25/04/2013 at 20:48. Pushed by ashark into branch 'docbook_historied_per_file'. Remove extra dots after entity Original commit: 073ca508 https://invent.kde.org/sdk/kdesrc-build/-/commit/073ca508e30b24ecdb2fa246506eee66feb41fbb M +1-1doc/introduction/brief-intro.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/97258efb3e18ca3d8b70d4b36425ba0bc9c94114 diff --git a/doc/introduction/brief-intro.docbook b/doc/introduction/brief-intro.docbook index ac82d1c6..98b880a4 100644 --- a/doc/introduction/brief-intro.docbook +++ b/doc/introduction/brief-intro.docbook @@ -34,7 +34,7 @@ sequence is followed: reads in the command line and configuration file, to determine what to build, compile options to use, where to install, -. + performs a source update for each module. The update continues until all modules
[sdk/kdesrc-build/docbook_historied_per_file] doc: Add a feature to kdesvn-build contributed by Tom Albers, --resume-after.
Git commit 8a270eeabc2258b895f78ddcca7e0c5449ce42f8 by Michael Pyne. Committed on 13/02/2010 at 04:12. Pushed by ashark into branch 'docbook_historied_per_file'. Add a feature to kdesvn-build contributed by Tom Albers, --resume-after. It's just like --resume-from, except that if you've already verified that your fix allows the module to build and install there's no reason to run kdesvn-build through the same process again. Using --resume-after tells kdesvn-build to pick up with the module after the one you've supplied (which would normally be the module that failed). CCMAIL:t...@kde.org svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=1089384 Original commit: 4506f185 https://invent.kde.org/sdk/kdesrc-build/-/commit/4506f18570e209a96441278c1443e66ec67810fb M +20 -1doc/cmdline/supported-cmdline-params.docbook M +1-0doc/index.docbook M +12 -3doc/using-kdesvn-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/8a270eeabc2258b895f78ddcca7e0c5449ce42f8 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 08c5757e..f068282f 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -204,7 +204,26 @@ This option is used to resume the build starting from the given module, which should be the next option on the command line. This option implies --no-src. You should not specify other module names on the command line. - + +See also: and . You would prefer to use this command line option +if you have fixed the build error and want 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. This option implies --no-src. You should not +specify other module names on the command line. + +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 to start again with the next +module. diff --git a/doc/index.docbook b/doc/index.docbook index c1fdfe55..62b1b51a 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -46,6 +46,7 @@ --nice'> --ignore-modules'> --resume-from'> + --resume-after'> --reconfigure'> --refresh-build'> diff --git a/doc/using-kdesvn-build/advanced-features.docbook b/doc/using-kdesvn-build/advanced-features.docbook index c034de01..79fef174 100644 --- a/doc/using-kdesvn-build/advanced-features.docbook +++ b/doc/using-kdesvn-build/advanced-features.docbook @@ -319,10 +319,10 @@ end global You can tell 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 - option. + option and the option. -Using will skip the source code update. - +Using either of the resume options will skip the source code +update. Resuming the build starting from kdebase: @@ -332,6 +332,15 @@ if you canceled a build run in the middle. You can control this using the + +Resuming the build starting after kdebase (in case you manually fixed +the issue and installed the module yourself): + + +% kdesvn-build --resume-after=kdebase + + +
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Move --list-installed to kdesrc-build
Git commit b0a0889e854870508c3552c17c7ee7c9de8da01a by Andrew Shark. Committed on 17/02/2024 at 14:09. Pushed by ashark into branch 'docbook_historied_per_file'. Move --list-installed to kdesrc-build Original commit: 733b4924 https://invent.kde.org/sdk/kdesrc-build/-/commit/733b492414f2c1e49986106070f05cf68cd1a752 M +9-0doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/b0a0889e854870508c3552c17c7ee7c9de8da01a diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index a6d1a9aa..fb02d2d3 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -350,6 +350,15 @@ kdepim: master + +--list-installed + + +Print installed modules and exit. This can be used to generate autocompletion for the --run option. + + + +
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Add build-system query mode
Git commit cfe814deaf97af88fcf007c198206e70d0964868 by Andrew Shark. Committed on 10/02/2024 at 12:33. Pushed by ashark into branch 'docbook_historied_per_file'. Add build-system query mode Original commit: 139fdc94 https://invent.kde.org/sdk/kdesrc-build/-/commit/139fdc94f4e4a469ff3b0f245a3626f3b58e3556 M +4-0doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/cfe814deaf97af88fcf007c198206e70d0964868 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 86eaf976..95367ed7 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -306,6 +306,10 @@ one of the following: output the name of module-set which contains the module. This can be used to generate zsh autocompletion cache. +build-system, which causes to +output the name of build system detected for the module. This can be used +to debug build system auto-detection problems, or when developing tests for specific build systems. + Any option name that is valid for modules in the configuration file.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Update docs to reflect new config file location changes
Git commit c3db6f7184531468b4b22a326c75548cecaf4dd5 by Ignacy Kajdan. Committed on 20/12/2021 at 10:17. Pushed by ashark into branch 'docbook_historied_per_file'. Update docs to reflect new config file location changes Original commit: df9212e4 https://invent.kde.org/sdk/kdesrc-build/-/commit/df9212e41d0a759075e4ec36d02803967be9ce6f M +5-3doc/cmdline/supported-cmdline-params.docbook M +17 -13 doc/getting-started/before-building.docbook M +10 -7doc/getting-started/configure-data.docbook M +10 -6doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/c3db6f7184531468b4b22a326c75548cecaf4dd5 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 25c4f8cc..75c2c452 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -496,9 +496,11 @@ This option was added with 1.16. See also the 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 . +kdesrc-buildrc (checked in the current working directory). +If this file doesn't exist, ~/.config/kdesrc-buildrc +($XDG_CONFIG_HOME/kdesrc-buildrc, if +$XDG_CONFIG_HOME is set) will be used instead. See also +. diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook index d6920929..b4853081 100644 --- a/doc/getting-started/before-building.docbook +++ b/doc/getting-started/before-building.docbook @@ -151,15 +151,17 @@ without having to fully specify its path every time. Prepare the configuration file - uses a configuration -file (located at ~/.kdesrc-buildrc) to control -which modules are built, where they are installed to, etc. + uses a configuration file +to control which modules are built, where they are installed to, etc. +This file is located at ~/.config/kdesrc-buildrc +($XDG_CONFIG_HOME/kdesrc-buildrc, if +$XDG_CONFIG_HOME is set). You can use a program included with , 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. +~/.config/kdesrc-buildrc configuration file to make +any changes you see fit. kdesrc-build-setup itself runs from a terminal (instead of using a graphical interface), just like , so you can @@ -169,17 +171,19 @@ 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. +included sample configuration file kdesrc-buildrc-kf5-sample +to ~/.config/kdesrc-buildrc and then editing the file. + will be a useful reference for this, especially +its table of configuration options. contains many recommended configuration files to support - Frameworks 5, 5, and other 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. + Frameworks 5, 5, and other 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 Setting the Configuration Data -To use , 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. +To use , you should have a file in your ~/.config +(or in $XDG_CONFIG_HOME, if set) directory called +kdesrc-buildrc, which sets the general options and +specifies the modules you would like to download and build. -It is possible to use different configuration files for , -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. + +It is possible to use different configuration files for , which is +described in . If you need to use multiple +configurations, please see that section. Here, we will assume that the +configuration is stored in ~/.config/kdesrc-buildrc. + The easiest way to proceed is to use the diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index d1dd4e9a..2ab71b5e 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++
[sdk/kdesrc-build/docbook_historied_per_file] doc: Add "generate-vscode-project-config" option
Git commit 6bd9334789b5b00a4e4bfc4a5fbf922f2a8b23dd by Andrew Shark, on behalf of Kristen McWilliam. Committed on 02/12/2023 at 16:16. Pushed by ashark into branch 'docbook_historied_per_file'. Add "generate-vscode-project-config" option This change adds `generate-vscode-project-config` option for `kdesrc-buildrc` and the corresponding command line flag. When set to `true`, kdesrc-build will create the `.vscode` folder in the module source directory with configuration that makes VSCode to work properly with KDE projects, such as setting the correct build directory & enabling support for C++, CMake, LSP & IntelliSense. The process specifically checks for an existing `.vscode` folder, in case the user already has custom settings present - and only proceeds if it does not exist yet. Closes #84 Original commit: 1d9b2355 https://invent.kde.org/sdk/kdesrc-build/-/commit/1d9b2355c10db4d8825cefe06c73b07d0b4f4373 M +8-0doc/cmdline/supported-cmdline-params.docbook M +27 -0doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/6bd9334789b5b00a4e4bfc4a5fbf922f2a8b23dd diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index ded50d26..5818d7a6 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -105,6 +105,14 @@ Enable colorful output. (This is the default for interactive terminals). + +--generate-vscode-project-config + +Generate a .vscode directory with configurations for building and debugging +in Visual Studio Code. + + + --nice=value diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 038b25e0..2f26df6f 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -809,6 +809,33 @@ due to changes in the project metadata. + +generate-vscode-project-config + + + +TypeBoolean +Default valueFalse + + +Module setting overrides global + +Set this option to true to make + create VS Code project files (.vscode directory) in the module +source directory. + +The .vscode folder will be created in the project source directory, only +if it does not already exist. The configurations will enable the use of LSP, +building, debugging, and running the project from within VS Code. + +The configuration also recommends extensions to install that are useful +for working on most KDE projects. + +You can also use the +--generate-vscode-project-config command line flag. + + + include-dependencies
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: doc: Define scopes for modules selection options
Git commit 43eee5b154b425e6ed3072eee4b3635d64c8efb0 by Andrew Shark. Committed on 29/01/2024 at 21:21. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Define scopes for modules selection options Original commit: d974610e https://invent.kde.org/sdk/kdesrc-build/-/commit/d974610efba6140798b10d13d092558e9226f796 M +16 -16 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/43eee5b154b425e6ed3072eee4b3635d64c8efb0 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 345ef74e..b35d520c 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -1,17 +1,16 @@ Table of available configuration options -Here is a table of the various options, containing the following +Here are tables of various options, containing the following information: The option name -A description of how responds if the option is -set in both the global section, and the module section of the configuration file while building a -module. +The scope of the option: global, module or module-set. +Options in module or/and module-set scope can also be defined in options sections. + Special comments on the purpose and usage of the option. @@ -1316,7 +1315,7 @@ installations. However this only works on build systems that support no-src -globalmodulemodule-setoptions +globalmodulemodule-set Remove update phase. The other phases that were presented will still be processed. Related command-line option: @@ -1325,7 +1324,7 @@ installations. However this only works on build systems that support no-install -globalmodulemodule-setoptions +globalmodulemodule-set Remove install phase. The other phases that were presented will still be processed. Related command-line option: @@ -1334,7 +1333,7 @@ installations. However this only works on build systems that support no-tests -globalmodulemodule-setoptions +globalmodulemodule-set Remove test phase. The other phases that were presented will still be processed. Related command-line option: --no-tests @@ -1343,7 +1342,7 @@ installations. However this only works on build systems that support no-build -globalmodulemodule-setoptions +globalmodulemodule-set Remove build phase. The other phases that were presented will still be processed. Related command-line option: @@ -1352,7 +1351,7 @@ installations. However this only works on build systems that support build-only -globalmodulemodule-setoptions +globalmodulemodule-set If had build phase, remove any other phases. Otherwise, remove all phases. Related command-line option: @@ -1361,7 +1360,7 @@ installations. However this only works on build systems that support install-only -globalmodulemodule-setoptions +globalmodulemodule-set If had install phase, remove any other phases. Otherwise, remove all phases. Related command-line option: @@ -1370,7 +1369,7 @@ installations. However this only works on build systems that support uninstall -globalmodulemodule-setoptions +globalmodulemodule-set If had uninstall phase, remove any other phases. Otherwise, remove all phases. Related command-line option: --uninstall @@ -1379,7 +1378,7 @@ installations. However this only works on build systems that support filter-out-phases -globalmodulemodule-setoptions +globalmodulemodule-set Remove those phases that are listed (space separated) in this option. The other phases that were presented will still be processed. @@ -1390,12 +1389,13 @@ installations. However this only works on build systems that support -Module-set and global scope options +Modules selection options Option name +Scope Description @@ -1404,12 +1404,12 @@ installations. However this only works on build systems that support ignore-modules +globalmodule-set TypeString Available since1.16 -This option can be used in global section and in module-sets. Note that when specified in global section, cmdline option does not override this, but instead appends. Modules named by this option, which would be chosen by due to a use-modules option, are @@ -1436,12 +1436,12 @@ is compared). use-modules +module-set TypeString Available since1.12.1 -Can only be used in module-set. This option allows you to easily specify many different modules to build at the same point in the configuration file.
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: doc: Fix typo dependend -> depended.
Git commit 5673daf1038bb93856328aa70d54089ac74ec974 by Michael Pyne, on behalf of Yuri Chornoivan. Committed on 27/04/2019 at 16:01. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Fix typo dependend -> depended. Differential Revision: https://phabricator.kde.org/D20174 Original commit: 3cc8391c https://invent.kde.org/sdk/kdesrc-build/-/commit/3cc8391c81b356025723cbcad12e92c1b8910315 M +1-1doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/5673daf1038bb93856328aa70d54089ac74ec974 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 04b0c2f4..0123ec89 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -535,7 +535,7 @@ also . Prints out dependency information on the modules that would be built using a tree format (recursive). Listed information also includes which specific commit/branch/tag -is dependend on and whether or not the dependency would be built. Note: the generated +is depended on and whether or not the dependency would be built. Note: the generated output may become quite large for applications with many dependencies.
[sdk/kdesrc-build/docbook_historied_per_file] doc: dep-resolv: Introduce --no-include-dependencies cmdline opt.
Git commit 81561a4c01d925fc96d9489027f2eae915ae69e4 by Michael Pyne. Committed on 31/08/2019 at 22:01. Pushed by ashark into branch 'docbook_historied_per_file'. dep-resolv: Introduce --no-include-dependencies cmdline opt. Does what it says on the tin, to permit disabling dependency inclusion on a one-time basis without editing config file. This just involved moving changing this option internally to be a 'global flag' which already are automagically able to be negated by precedining with --no-. When adding documentation for it I noticed I had not documented it in the Docbook docs so I've added docs for that and --include-dependencies also and updated copyright. This should also support updating other documentation for the issue being tracked at #31 Original commit: 6c10817e https://invent.kde.org/sdk/kdesrc-build/-/commit/6c10817e55adcbb14ff17b5df8c224f5e416862c M +20 -0doc/cmdline/supported-cmdline-params.docbook M +2-1doc/index.docbook M +3-3doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/81561a4c01d925fc96d9489027f2eae915ae69e4 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 0123ec89..25c4f8cc 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -196,6 +196,26 @@ work. + +--include-dependencies +--no-include-dependencies + +This option causes to automatically include other and +modules in the build, if required for the modules you have requested to build +on the command line or in your +configuration file. + +The modules that are added are as recorded within the source code +management system. See . + +The corresponding configure file option is +include-dependencies. + +You can also use --no-include-dependencies, which turns off +automatic inclusion of additional dependency modules. + + + --ignore-modules diff --git a/doc/index.docbook b/doc/index.docbook index 95c98c33..d9115de7 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -2,7 +2,7 @@ +Copyright (c) 2005-2008, 2010-2019 Michael Pyne Copyright (c) 2005 Carlos Leonhard Woelz Copyright (c) 2009 Burkhard Lück @@ -133,6 +133,7 @@ 2016 2017 2018 +2019 Michael Pyne diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index e03acc8d..1d0e8ca7 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -576,9 +576,9 @@ modules, and requires that the metadata maintained by the 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 -1.16 in 2015. +This option is enabled by default, to support building applications +that need versions of or more recent than supported on +common operating systems.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Use XDG_STATE_HOME for persistent data file
Git commit 23df6e04c36ac3b92e726852e5165906bb324c8d by Ignacy Kajdan. Committed on 21/01/2022 at 17:40. Pushed by ashark into branch 'docbook_historied_per_file'. Use XDG_STATE_HOME for persistent data file Original commit: 4a2c0a8f https://invent.kde.org/sdk/kdesrc-build/-/commit/4a2c0a8fe776490fde92bec120bfae51d9e9c982 M +5-3doc/cmdline/supported-cmdline-params.docbook M +17 -13 doc/getting-started/before-building.docbook M +10 -7doc/getting-started/configure-data.docbook M +26 -15 doc/kdesrc-buildrc/conf-options-table.docbook M +57 -7doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/23df6e04c36ac3b92e726852e5165906bb324c8d diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 25c4f8cc..75c2c452 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -496,9 +496,11 @@ This option was added with 1.16. See also the 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 . +kdesrc-buildrc (checked in the current working directory). +If this file doesn't exist, ~/.config/kdesrc-buildrc +($XDG_CONFIG_HOME/kdesrc-buildrc, if +$XDG_CONFIG_HOME is set) will be used instead. See also +. diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook index d6920929..b4853081 100644 --- a/doc/getting-started/before-building.docbook +++ b/doc/getting-started/before-building.docbook @@ -151,15 +151,17 @@ without having to fully specify its path every time. Prepare the configuration file - uses a configuration -file (located at ~/.kdesrc-buildrc) to control -which modules are built, where they are installed to, etc. + uses a configuration file +to control which modules are built, where they are installed to, etc. +This file is located at ~/.config/kdesrc-buildrc +($XDG_CONFIG_HOME/kdesrc-buildrc, if +$XDG_CONFIG_HOME is set). You can use a program included with , 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. +~/.config/kdesrc-buildrc configuration file to make +any changes you see fit. kdesrc-build-setup itself runs from a terminal (instead of using a graphical interface), just like , so you can @@ -169,17 +171,19 @@ 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. +included sample configuration file kdesrc-buildrc-kf5-sample +to ~/.config/kdesrc-buildrc and then editing the file. + will be a useful reference for this, especially +its table of configuration options. contains many recommended configuration files to support - Frameworks 5, 5, and other 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. + Frameworks 5, 5, and other 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 Setting the Configuration Data -To use , 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. +To use , you should have a file in your ~/.config +(or in $XDG_CONFIG_HOME, if set) directory called +kdesrc-buildrc, which sets the general options and +specifies the modules you would like to download and build. -It is possible to use different configuration files for , -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. + +It is possible to use different configuration files for , which is +described in . If you need to use multiple +configurations, please see that section. Here, we will assume that the +configuration is stored in ~/.config/kdesrc-buildrc. + The easiest way to proceed is to use the diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 64230a63..379cfa80 100644 ---
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Remove --print-modules and --list-build options
Git commit 75b4b0eb0cb4e472b7ca1c58dd2cc77839a6855f by Andrew Shark. Committed on 10/02/2024 at 09:37. Pushed by ashark into branch 'docbook_historied_per_file'. Remove --print-modules and --list-build options There are already `--query module-set` and `--query branch` options, no need to create unnecessarily entities. The --list-build tree indentation was not properly implemented, but made correctly in dependency-tree. The #dependency-level sticky option was never set, so print-modules indentation was broken forever. The zsh completion script relied on --list-build option and needs to be reworked. Original commit: 08c6bb39 https://invent.kde.org/sdk/kdesrc-build/-/commit/08c6bb39486fc51aca90a20708f65ee3ae7eb0eb M +0-48 doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/75b4b0eb0cb4e472b7ca1c58dd2cc77839a6855f diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index b52bf204..86eaf976 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -323,54 +323,6 @@ kdepim: master - - ---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 ---pretend or --no-src). - - -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 -understands a module's dependencies to be, which means it's only useful for -kde-projects -modules. This option is also compatible with --resume-from, --resume-after, ---stop-before, ---stop-after. - - - - ---list-build - - -Lists the modules that would be built, in the order in which they would be built. -If applicable, the output listing also mentions which commit/branch/tag would be -selected for checkout. - - -This option is similar to ---print-modules. -For more detailed information on how modules relate to each other, see also: ---dependency-tree. - - - - --dependency-tree
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: query: Make behavior the same when one module is queried
Git commit 7e3a739d6aa461802c2cca38bdc904ae4aa82f4a by Andrew Shark. Committed on 05/02/2024 at 14:20. Pushed by ashark into branch 'docbook_historied_per_file'. query: Make behavior the same when one module is queried Original commit: 49ec03c7 https://invent.kde.org/sdk/kdesrc-build/-/commit/49ec03c7dca5a0cabaeb54fb34a9100dd6c2b2e4 M +0-7doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/7e3a739d6aa461802c2cca38bdc904ae4aa82f4a diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 7c4f8f31..4cb6e494 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -307,13 +307,6 @@ one of the following: - -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, - stops running once each value is output. - - For example, the command kdesrc-build --query branch kactivities kdepim
[sdk/kdesrc-build/docbook_historied_per_file] doc: Add --resume (and --stop-on-failure) command line options.
Git commit 09b14a79b4c3223731b3b7f040da61795b5ef9bf by Michael Pyne. Committed on 16/03/2014 at 03:15. Pushed by ashark into branch 'docbook_historied_per_file'. Add --resume (and --stop-on-failure) command line options. Now you don't have to do --stop-on-failure=1. --resume is documented in the man page and docbook, but basically lets you resume the last build list quickly without source or metadata updates, starting from the module that failed. If you want to skip the failed module, look into --resume-after and --stop-before. BUG:331941 FIXED-IN:1.16 Original commit: 72229099 https://invent.kde.org/sdk/kdesrc-build/-/commit/7222909901afcf1a2f1f395714e6ed0ac46020f6 M +40 -0doc/cmdline/supported-cmdline-params.docbook M +8-0doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/09b14a79b4c3223731b3b7f040da61795b5ef9bf diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index b838a4ca..3e85994f 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -274,6 +274,33 @@ yourself, and want to start again with the next module. + +--resume + + +This option can be used to run 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 +--resume-from and +--stop-before. + + +This is even handier with the --stop-on-failure command +line argument, especially if you're initially setting up your development +environment. + + +This option was added with 1.16. + + + + --stop-before @@ -304,6 +331,19 @@ This command line option was added with 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, + 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 1.16. See also the +stop-on-failure option. + + + --rc-file diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index a2068400..62a2b38b 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -349,6 +349,14 @@ the issue and installed the module yourself): +If the last 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. + +
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: RecursiveFH: Support variables in include lines
Git commit 17b9fd13a5236d572d3e502811e91d1cb604477b by Andrew Shark.
Committed on 02/02/2024 at 08:07.
Pushed by ashark into branch 'docbook_historied_per_file'.
RecursiveFH: Support variables in include lines
Original commit: 399806c1
https://invent.kde.org/sdk/kdesrc-build/-/commit/399806c1efd4514b75c9f1254bb4b408f02a7221
M +12 -0doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/17b9fd13a5236d572d3e502811e91d1cb604477b
diff --git a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
index 0ac0cf6f..3469e11d 100644
--- a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
+++ b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
@@ -219,6 +219,18 @@ end global
the file will be searched for starting from the directory containing the source
file. This works recursively as well.
+You can use variables in the value of include instruction:
+
+global
+ _ver 6
+ source-dir ~/kde${_ver}/src
+ ...
+ persistent-data-file
~/kde${_ver}/persistent-options.json
+end global
+
+include
~/kde6/src/kdesrc-build/data/build-include/kf${_ver}-qt${_ver}.ksb
+
+
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: xsession: Add option to allow overwriting existing login mgr config.
Git commit 271299a68d0410530f93c1a9991d93511f0f8429 by Michael Pyne. Committed on 29/10/2012 at 03:11. Pushed by ashark into branch 'docbook_historied_per_file'. xsession: Add option to allow overwriting existing login mgr config. This implements the command line option mentioned in the last commit, to allow for overwriting .xsession (and possibly .kde-env-master.sh, if it exists). Probably would still be a good idea to make a backup though. Original commit: f821c713 https://invent.kde.org/sdk/kdesrc-build/-/commit/f821c713c220b07298499adace273367ee4ac113 M +26 -0doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/271299a68d0410530f93c1a9991d93511f0f8429 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 2c435608..cc2498ba 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -356,6 +356,32 @@ aid. + +--delete-my-patches + +This option is used to let delete source directories that may +contain user data, so that the module can be re-downloaded. This would normally +only be useful for developers (who might have local changes that would be +deleted). + +This is currently only used to checkout modules that have been converted +from to . You should not use this option normally, + will prompt to be re-run with it if it is needed. + + + + +--delete-my-settings + +This option is used to let 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, will prompt to be re-run +with it if it is needed. + + + --option-name=
[sdk/kdesrc-build/docbook_historied_per_file] doc: Correct documentation regarding --resume-foo.
Git commit f0bc683f56aa4130797d48d6028dd1256090eee4 by Michael Pyne. Committed on 23/02/2011 at 03:45. Pushed by ashark into branch 'docbook_historied_per_file'. Correct documentation regarding --resume-foo. Original commit: 45128e86 https://invent.kde.org/sdk/kdesrc-build/-/commit/45128e86d0ebb66ef3531416f49e2ac24615ea47 M +18 -4doc/cmdline/supported-cmdline-params.docbook M +4-2doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/f0bc683f56aa4130797d48d6028dd1256090eee4 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 7a3e1e0f..181b1428 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -216,10 +216,17 @@ linkend="cmdline-refresh-build">--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. This option implies --no-src. You should not +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 1.13). If you want to avoid source updates +when resuming, simply pass --no-src +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 to complete the @@ -230,10 +237,17 @@ 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. This option implies --no-src. You should not +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 1.13). If you want to avoid source updates +when resuming, simply pass --no-src +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 diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index 37e14d06..fd1deaa6 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -327,8 +327,10 @@ 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 option and the option. -Using either of the resume options will skip the source code -update. +Older versions of would skip the source update when +resuming a build. This is no longer done by default, but you can always use +the --no-src command line option +to skip the source update. Resuming the build starting from kdebase:
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Remove update-shellrc step
Git commit ba7e1d479cb21d3fa05efbd4a88adaae539f084d by Andrew Shark. Committed on 15/02/2024 at 11:44. Pushed by ashark into branch 'docbook_historied_per_file'. Remove update-shellrc step It basically just added to the shellrc the path to the running script. That is not handled correctly in all cases. Also, it tried to add kdesrc-run bash autocompletion, but the code was not handling all cases correctly anyway. Instead, we will offer to install the file in the correct place in the first place. Regarding PATH, that should be in user's control. Original commit: 5d7dcace https://invent.kde.org/sdk/kdesrc-build/-/commit/5d7dcacee6fd89feae01f197e278f61a1ddead8b M +1-12 doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/ba7e1d479cb21d3fa05efbd4a88adaae539f084d diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index c3202192..a6d1a9aa 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -564,12 +564,11 @@ software to run. Installing known dependencies (on supported distributions) Adding required environment variables to ~/.bashrc -Setting up a configuration file This option is exactly equivalent to using --install-distro-packages --generate-config ---update-shellrc at the same time. +at the same time. @@ -593,16 +592,6 @@ Generate the configuration file. - ---update-shellrc - -Edit the "~/.bashrc" (or other shell rc file) to add to your $PATH variable and enable autocompletion. - -See also --initial-setup - - - -
[sdk/kdesrc-build/docbook_historied_per_file] doc: GIT_SILENT doc: Bump version. (silent)
Git commit f8d39f4f36eb168782ef16db63c9f0eae1671ce7 by Michael Pyne. Committed on 08/09/2011 at 03:23. Pushed by ashark into branch 'docbook_historied_per_file'. GIT_SILENT doc: Bump version. Original commit: 07de9f7c https://invent.kde.org/sdk/kdesrc-build/-/commit/07de9f7c308ad793880c510b016d49962e2cb010 M +2-2doc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/f8d39f4f36eb168782ef16db63c9f0eae1671ce7 diff --git a/doc/index.docbook b/doc/index.docbook index ada9e33f..62ca3244 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -114,8 +114,8 @@ -2011-02-20 -1.13 +2011-09-07 +1.14 is a script which builds and installs software
[sdk/kdesrc-build/docbook_historied_per_file] doc: doc: Document xsession changes.
Git commit 6e9e91ac2977b4188e33db228e9e794bda2fdfb6 by Michael Pyne. Committed on 19/11/2012 at 01:14. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Document xsession changes. Original commit: fb5bd6fc https://invent.kde.org/sdk/kdesrc-build/-/commit/fb5bd6fc33e2c8e1519927780afe3ba8633f1bbf M +1-2doc/appendix-modules/index.docbook A +6-0doc/appendix-profile/index.docbook C +11 -9doc/appendix-profile/old-profile-setup.docbook [from: doc/getting-started/environment.docbook - 090% similarity] M +26 -0doc/cmdline/supported-cmdline-params.docbook M +115 -153 doc/getting-started/environment.docbook M +1-1doc/getting-started/kde-modules-and-selection.docbook M +4-0doc/index.docbook M +26 -0doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/6e9e91ac2977b4188e33db228e9e794bda2fdfb6 diff --git a/doc/appendix-modules/index.docbook b/doc/appendix-modules/index.docbook index 0adaebcd..a93a825b 100644 --- a/doc/appendix-modules/index.docbook +++ b/doc/appendix-modules/index.docbook @@ -1,5 +1,4 @@ - + modules and source code organization - diff --git a/doc/appendix-profile/index.docbook b/doc/appendix-profile/index.docbook new file mode 100644 index ..c5fcd59b --- /dev/null +++ b/doc/appendix-profile/index.docbook @@ -0,0 +1,6 @@ + +Superseded profile setup procedures + + + + diff --git a/doc/getting-started/environment.docbook b/doc/appendix-profile/old-profile-setup.docbook similarity index 90% copy from doc/getting-started/environment.docbook copy to doc/appendix-profile/old-profile-setup.docbook index 8cfb707c..e0781b2a 100644 --- a/doc/getting-started/environment.docbook +++ b/doc/appendix-profile/old-profile-setup.docbook @@ -1,12 +1,14 @@ - -Setting the Environment to Run Your Fresh - - -Assuming you are using a dedicated user to build , and you already have -an installed version, running your new may be a bit tricky, as the new -has to take precedence over the old. Change the environment variables to -make sure it does. - + +Setting up a login profile + +These instructions cover how to setup the profile required to ensure your +computer can login to your newly-built desktop. +will normally try to do this automatically (see ). This appendix section can be useful for those who +cannot use '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 +source. Changing your startup profile settings diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 2c435608..cc2498ba 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -356,6 +356,32 @@ aid. + +--delete-my-patches + +This option is used to let delete source directories that may +contain user data, so that the module can be re-downloaded. This would normally +only be useful for developers (who might have local changes that would be +deleted). + +This is currently only used to checkout modules that have been converted +from to . You should not use this option normally, + will prompt to be re-run with it if it is needed. + + + + +--delete-my-settings + +This option is used to let 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, will prompt to be re-run +with it if it is needed. + + + --option-name= diff --git a/doc/getting-started/environment.docbook b/doc/getting-started/environment.docbook index 8cfb707c..7e438b10 100644 --- a/doc/getting-started/environment.docbook +++ b/doc/getting-started/environment.docbook @@ -1,165 +1,127 @@ -Setting the Environment to Run Your Fresh +Setting the Environment to Run Your Desktop -Assuming you are using a dedicated user to build , and you already have -an installed version, running your new may be a bit tricky, as the new -has to take precedence over the old. Change the environment variables to -make sure it does. +Assuming you are using a dedicated user to build , and you already have an +installed version, running your new may be a bit tricky, as the new + 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. - -Changing your startup profile settings - -The .bash_profile is the login settings -file for the popular bash shell used by many -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) #
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: doc: List --run in commonly used options
Git commit 219908425b341589dc901d7158b7a687e0d121ef by Andrew Shark. Committed on 20/02/2024 at 21:29. Pushed by ashark into branch 'docbook_historied_per_file'. doc: List --run in commonly used options Reference full documentation from --help. No need to keep yet another place of options listing. Original commit: 19044150 https://invent.kde.org/sdk/kdesrc-build/-/commit/19044150a44a2f7a18d89a1e74dbcc0b5f696c6e M +54 -42 doc/cmdline/cmdline-usage.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/219908425b341589dc901d7158b7a687e0d121ef diff --git a/doc/cmdline/cmdline-usage.docbook b/doc/cmdline/cmdline-usage.docbook index 3bad3988..e0110ce9 100644 --- a/doc/cmdline/cmdline-usage.docbook +++ b/doc/cmdline/cmdline-usage.docbook @@ -14,48 +14,6 @@ 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: - - - ---pretend (or -p) -This option causes 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. - - - ---refresh-build -This option forces 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 or -libraries change. - - - ---no-src -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 ) but still want to rebuild some -modules. - - - ---no-build -This option is similar to --no-src above, -but this time the build process is skipped. - - - - - Specifying modules to build @@ -93,4 +51,58 @@ option before building a new module set to ensure it is only building the modules you want. + + +Commonly used command line options + + + +--pretend (or -p) +This option causes 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. + + + +--no-src +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 ) but still want to rebuild some + modules. + + + +--no-include-dependencies (or -D) +Only process the selected modules, skipping their dependencies. + Useful when you have changed only selected modules, and you are sure you + do not need to rebuild the others. + + + +--refresh-build (or -r) +This option forces 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 or + libraries change. + + + +--resume-from module +Skips modules until just before the given module, then operates as normal. + Useful when the previous build failed on specific module, you fixed it, and then you + want to continue the with building the rest of initial set of modules. + + + +--run module +Launch the built application. + + + + The full list of command line options is given in . + +
[sdk/kdesrc-build/docbook_historied_per_file] doc: Support SIGHUP for graceful script exit.
Git commit 7a781d2cb74cf7876ce96654dd4013347ee6c71a by Michael Pyne. Committed on 14/07/2022 at 04:11. Pushed by ashark into branch 'docbook_historied_per_file'. Support SIGHUP for graceful script exit. This helps if a user started a long build without --stop-on-failure and needs it to stop without risking interrupting kdesrc-build during an install step. Fixes #96. Original commit: e5a9295b https://invent.kde.org/sdk/kdesrc-build/-/commit/e5a9295bccf07ed0ca9d9729b7ca72ec193f5a2d M +1-1doc/index.docbook M +96 -0doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/7a781d2cb74cf7876ce96654dd4013347ee6c71a diff --git a/doc/index.docbook b/doc/index.docbook index 8f17fd5e..73310e92 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -2,7 +2,7 @@ +Copyright (c) 2005-2008, 2010-2022 Michael Pyne Copyright (c) 2005 Carlos Leonhard Woelz Copyright (c) 2009 Burkhard Lück diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index 6c41cc2e..0e4d568f 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -175,6 +175,102 @@ as well. + +Stopping the build early + + +The build normally continues even if failures occur + + normally will update, build and install all modules +in the specified list of modules to build, even if a module fails to build. +This is usually a convenience to allow you to update software packages even +if a simple mistake is made in one of the source repositories during +development that causes the build to break. + + + +However you may wish for to stop what it is doing once a +module fails to build and install. This can help save you time that will be +wasted trying to make progress when modules remaining in the build list will +not be able to successfully build either, especially if you have not ever +successfully built the modules in the list. + + + + + +Stopping early with --stop-on-failure + + +The primary method to do this is to use the +--stop-on-failure +command line option when you run . + + +This option can also be set in the +configuration file to make +it the normal mode of operation. + + +It is also possible to tell at runtime to stop building +after completing the current module it is working on. +This is as opposed to interrupting using a command like +C, which interrupts + immediately, losing the progress of the current module. + + +Interrupting during a module install when +the use-clean-install option +is enabled will mean that the interrupted module will be unavailable until + is able to successfully build the module! + +If you need to interrupt without permitting a graceful shutdown +in this situation, at least try to avoid doing this while is +installing a module. + + + + + +Stopping early without --stop-on-failure + +As mentioned above, it is possible to cause to gracefully +shutdown early once it has completed the module it is currently working on. +To do this, you need to send the POSIX HUP signal to + + +You can do this with a command such as pkill (on systems) as follows: + + +$ pkill -HUP kdesrc-build + + +If done successfully, you will see a message in the output similar +to: + + +[ build ] recv SIGHUP, will end after this module + + + + may show this message multiple times depending on the +number of individual processes that are active. This is +normal and not an indication of an error. + + + +Once has acknowledged the signal, it will stop processing +after the current module is built and installed. If is still +updating source code when the request is received, will stop +after the module source code update is complete. Once both the update and build +processes have stopped early, will print its partial results +and exit. + + + + + + How tries to ensure a successful build
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Add support for Meson build system.
Git commit 6b226e2ce10c359f7b803a160020dcec7ec5b8ac by Michael Pyne. Committed on 04/05/2019 at 20:15. Pushed by ashark into branch 'docbook_historied_per_file'. Add support for Meson build system. New/updated config file options: * 'configure-flags', reused as the way to pass cmdline options to the meson setup command. * 'ninja-options', a new option to pass cmdline options to the `ninja` command. Note that ninja is mandated by Meson as the underlying build tool. Tested with https://github.com/plibither8/2048.cpp Fixes #27, reviewed in !8. Test suite passes and I continue to be able to build 2048.cpp. I've also validated that ninja-options is passed to ninja when building 2048.cpp, though this was a manual verification. CCBUG:406268 Original commit: 6385f5e4 https://invent.kde.org/sdk/kdesrc-build/-/commit/6385f5e429dd11393b48690a33d67a66edeacfd2 M +43 -2doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/6b226e2ce10c359f7b803a160020dcec7ec5b8ac diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index f9875f8f..e03acc8d 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -720,10 +720,15 @@ 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 +Set this variable in order to pass command line options to the make command. This is useful for programs such as https://github.com/distcc/distcc;>distcc or -systems with more than one processor core. +systems with more than one processor core. +Note that not all supported build systems use make. For +build systems that use ninja for build (such as the +Meson +build system), see the ninja-options +setting. @@ -781,6 +786,36 @@ number, the "nicer" the program is. The default is 10. + +ninja-options +Module setting overrides global (build system option) +Set this variable in order to pass command line options to the + +ninja build command. This can be useful to enable verbose output +or to manually reduce the number of parallel build jobs that ninja would +use. + +Note that this setting only controls ninja when used by . +The webengine module uses ninja indirectly, but +only officially supports being built by make. +In this situation, you can set NINJAFLAGS as a way to have +make pass the appropriate flags when it later calls +ninja, by using +make-options. + + + +options qtwebengine +# Restrict make and ninja to using no more than 6 separate compile jobs even +# when more CPU is available, to avoid running out of memory +make-options -j6 NINJAFLAGS=-j6 +end options + + + + + + no-svn Module setting overrides global @@ -836,6 +871,12 @@ the auto-detection. In this case you can manually specify the correct build type This is the standard configuration tool used for most Free and open-source software not in any of the other categories. + +meson +This is a https://mesonbuild.com;>relatively new +tool gaining popularity as a replacement for the autotools and may +be required for some non- modules. +
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Fix default value for "directory-layout" option
Git commit b638608f66252e84f507afb8cd56b7f7c65c05c2 by Andrew Shark. Committed on 09/01/2024 at 07:52. Pushed by ashark into branch 'docbook_historied_per_file'. Fix default value for "directory-layout" option It was silently allowed to have unset "directory-layout" option value, that was treated as "metadata" value. Previously, it defaulted to "metadata". Then commit 7fe7c940 (BUG: 461279) changed the default value in documentation to "flat", but not in the code. This commit treats any incorrect value (not one of "flat", "invent", "metadata"), including empty string, as a "flat" value with warning. Add the forgotten default BuildContext value, and add it in FirstRun. Original commit: 642bdc2e https://invent.kde.org/sdk/kdesrc-build/-/commit/642bdc2e326f8eae6cbc2a07bfe37fc1044952b9 M +8-7doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/b638608f66252e84f507afb8cd56b7f7c65c05c2 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index c23c2c1b..e74858b1 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -695,10 +695,11 @@ on also use that proxy server, if possible, by setting the TypeString Valid valuesflat, invent, metadata +Default valueflat This option is used to configure the layout which should use when creating source and build directories. -The flat layout is the default value, and will group all modules +The flat layout will group all modules directly underneath the top level source and build directories. For example, source/extragear/network/telepathy/ktp-text-ui in the metadata layout would be source/ktp-text-ui using the flat layout @@ -727,19 +728,19 @@ due to changes in the project metadata. TypeBoolean Default valueFalse - + Module setting overrides global -Set this option to true to make - create VS Code project files (.vscode directory) in the module +Set this option to true to make + create VS Code project files (.vscode directory) in the module source directory. -The .vscode folder will be created in the project source directory, only -if it does not already exist. The configurations will enable the use of LSP, +The .vscode folder will be created in the project source directory, only +if it does not already exist. The configurations will enable the use of LSP, building, debugging, and running the project from within VS Code. -The configuration also recommends extensions to install that are useful +The configuration also recommends extensions to install that are useful for working on most KDE projects. You can also use the
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: GIT_SILENT doc: Correct obvious error w/ install-session-driver docs. (silent)
Git commit bbc106ef5f76f8839c806a51c65093c76c81ce01 by Michael Pyne. Committed on 30/03/2014 at 02:54. Pushed by ashark into branch 'docbook_historied_per_file'. GIT_SILENT doc: Correct obvious error w/ install-session-driver docs. Original commit: 27320ea5 https://invent.kde.org/sdk/kdesrc-build/-/commit/27320ea558b8039ccee4ed77c706c664ad7f2bbc M +1-1doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/bbc106ef5f76f8839c806a51c65093c76c81ce01 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 4f86bcdb..e6a550bd 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -549,7 +549,7 @@ login manager that allows you to login to your -built deskto This driver will alter the following files: -~/.xsession (normally found at ~/.config/kde-env-master.sh). +~/.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).
[sdk/kdesrc-build/docbook_historied_per_file] doc: GIT_SILENT Update copyrights. (silent)
Git commit 17ec2cedcdda2e44783e0f49ab5843a5c312d4c1 by Michael Pyne. Committed on 11/03/2015 at 02:24. Pushed by ashark into branch 'docbook_historied_per_file'. GIT_SILENT Update copyrights. Original commit: 96cee64b https://invent.kde.org/sdk/kdesrc-build/-/commit/96cee64b21edd754552565f49be655cab3302adc M +2-1doc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/17ec2cedcdda2e44783e0f49ab5843a5c312d4c1 diff --git a/doc/index.docbook b/doc/index.docbook index 2e9d84e3..cf157d6f 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -131,6 +131,7 @@ 2012 2013 2014 +2015 Michael Pyne @@ -141,7 +142,7 @@ -2014-01-25 +2015-03-07 1.16
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Add support for overridding detected build system.
Git commit 49351d3df66745e04d7f982019951e864c0488fc by Michael Pyne. Committed on 01/09/2012 at 23:41. Pushed by ashark into branch 'docbook_historied_per_file'. Add support for overridding detected build system. This is necessary in situations where the source includes more than one build system (especially when only one of those actually works but kdesrc-build auto-detects the other). The current example would be libraptor. Original commit: c29948e3 https://invent.kde.org/sdk/kdesrc-build/-/commit/c29948e3a5325a3178c7162e3b1261af6ae7fed4 M +40 -0doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/49351d3df66745e04d7f982019951e864c0488fc diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 9e47c5c5..dfcaac2b 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -579,6 +579,46 @@ module if it normally would have tried anyways. due to fixes in the underlying build system. + +override-build-system +Module setting overrides global +This is an advanced option, added in 1.16. + +Normally 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 modules. In reality it can be used to build +almost any module that uses but it is best not to rely on this. + + +Qt +Used to build the library itself. + + +qmake +Used to build modules that use +qmake-style .pro +files. + + +generic +Used to build modules that use plain Makefiles and that do not +require any special configuration. + + + + + + override-url Module setting overrides global
[sdk/kdesrc-build/docbook_historied_per_file] doc: Update documentation to cover CMake generator support.
Git commit e5c002cc7030022e71c4c7b7c9770e284879a33d by Johan Ouwerkerk. Committed on 04/01/2020 at 13:27. Pushed by ashark into branch 'docbook_historied_per_file'. Update documentation to cover CMake generator support. Original commit: 54621a06 https://invent.kde.org/sdk/kdesrc-build/-/commit/54621a068cbab5706178b6033322b4acfb474052 M +1-1doc/getting-started/before-building.docbook M +1-0doc/index.docbook M +20 -0doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/e5c002cc7030022e71c4c7b7c9770e284879a33d diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook index 16ea996c..dd686f6a 100644 --- a/doc/getting-started/before-building.docbook +++ b/doc/getting-started/before-building.docbook @@ -89,7 +89,7 @@ recommended packages for major distributions. You will need a build tool that actually performs the compilation steps (as generated by ). GNU Make is recommended and should be available through your package manager. does support others options, such -as the "ninja" build tool, which can be used by using the +as the build tool, which can be used by using the custom-build-command configuration file option. diff --git a/doc/index.docbook b/doc/index.docbook index d9115de7..e74c2e86 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -27,6 +27,7 @@ Git'> CMake'> Make'> + Ninja'> SSH'> Cron'> Subversion'> diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 1d0e8ca7..b3ab4420 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -226,6 +226,20 @@ operation of the source control system. See for an example. + +cmake-generator +Module setting overrides global +Use this option to specify which generator to use with . +Currently both Ninja and Unix Makefiles +are supported. Invalid (unsupported) values are ignored and treated as if +unset. If not set Unix Makefiles will be used by default. + + +Note that if a valid generator is also specified through +cmake-options it will override the +value for cmake-generator. + + cmake-options Appends to global options for the default buildsystem, overrides global @@ -239,6 +253,12 @@ specify common options in the global section. This option does not apply to qt (which does not use ). Use configure-flags instead. +If a valid generator is specified among the listed options it will +override the value of +cmake-generator. Invalid +(unsupported) generators are ignored and will not be passed to . + + Since these options are passed directly to the command line, they should be given as they would be typed into . For example:
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: doc: Deprecate use-stable-kde.
Git commit 13c118fd92c5061cf8f7db43b1aab76157d66bc5 by Michael Pyne. Committed on 30/03/2014 at 03:01. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Deprecate use-stable-kde. Original commit: e8880783 https://invent.kde.org/sdk/kdesrc-build/-/commit/e88807834ba9365ca7551238ac8a9955ba613814 M +4-16 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/13c118fd92c5061cf8f7db43b1aab76157d66bc5 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index e6a550bd..9fd94b26 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -1024,23 +1024,11 @@ system. use-stable-kde Can't be overridden -By default, will build the main line of -development (trunk or master branch). You can use the option globally -or for a module in order to switch to a stable release. However, this is not -convenient as a lot of branch options would have to be added to the -configuration file and kept up to date when the next stable version is -released. - -So, if you set this option to true, - will (for a given module) automatically download the version of -that module which is marked as stable in kde_projects.xml. - -This option can only be set globally, but you can still use the -or options for a module to override this option. -This way you can easily choose to download current stable version by default -while still choosing the current development version of specific modules. - + +This option is deprecated and will be removed (again) in a future release. +Please use the branch-group +instead, which offers more selectivity.
[sdk/kdesrc-build/docbook_historied_per_file] doc: More kdesrc-build doc fixes, as noticed by Burkhard Lück.
Git commit 37b5576a947137fe7bdd2c5bfd44b3ba9b41758b by Michael Pyne. Committed on 08/09/2010 at 23:15. Pushed by ashark into branch 'docbook_historied_per_file'. More kdesrc-build doc fixes, as noticed by Burkhard Lück. svn path=/trunk/KDE/kdesdk/doc/scripts/kdesrc-build/; revision=1173206 Original commit: 84b1d7c2 https://invent.kde.org/sdk/kdesrc-build/-/commit/84b1d7c239cdca783c373c0cf998faee0deab031 M +1-1doc/features/features-overview.docbook M +2-2doc/getting-started/building-and-troubleshooting.docbook M +1-1doc/getting-started/environment.docbook M +4-4doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/37b5576a947137fe7bdd2c5bfd44b3ba9b41758b diff --git a/doc/features/features-overview.docbook b/doc/features/features-overview.docbook index f9dc384c..e159e07c 100644 --- a/doc/features/features-overview.docbook +++ b/doc/features/features-overview.docbook @@ -158,7 +158,7 @@ a base single-user installation from the anonymous repository Tilde-expansion for your configuration options. For example, you can specify: -qtdir ~/kdesvn/build/qt-copy +qtdir ~/kdesrc/build/qt-copy diff --git a/doc/getting-started/building-and-troubleshooting.docbook b/doc/getting-started/building-and-troubleshooting.docbook index c6c2692c..d414d44a 100644 --- a/doc/getting-started/building-and-troubleshooting.docbook +++ b/doc/getting-started/building-and-troubleshooting.docbook @@ -17,9 +17,9 @@ will not succeed the first time you compile . Do not despair! logs the output of every command it runs. By default, -the log files are kept in ~/kdesvn/log. To see what +the log files are kept in ~/kdesrc/log. To see what the caused an error for a module in the last command, usually -it is sufficient to look at ~/kdesvn/log/latest/module-name/error.log. +it is sufficient to look at ~/kdesrc/log/latest/module-name/error.log. 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 diff --git a/doc/getting-started/environment.docbook b/doc/getting-started/environment.docbook index 72e601f9..6d5463b2 100644 --- a/doc/getting-started/environment.docbook +++ b/doc/getting-started/environment.docbook @@ -23,7 +23,7 @@ and add to the end of the file: If you are building the qt-copy module (you are by default), add instead: -QTDIR=(path to qtdir) # Such as ~/kdesvn/build/qt-copy by default. +QTDIR=(path to qtdir) # Such as ~/kdesrc/build/qt-copy by default. KDEDIR=(path to kdedir) # Such as ~/kde by default. KDEDIRS=$KDEDIR PATH=$KDEDIR/bin:$QTDIR/bin:$PATH diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index 62f83949..37e14d06 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -273,15 +273,15 @@ next time the build process occurs, even if it would normally perform the faster incremental build. -By default, the build directory is ~/kdesvn/build/module/. +By default, the build directory is ~/kdesrc/build/module/. If you change the setting of the option, then use that instead of -~/kdesvn/build. +~/kdesrc/build. -Rebuild using .refresh-me for module arts: +Rebuild using .refresh-me for module kdelibs: -% touch ~/kdesvn/build/arts.refresh-me +% touch ~/kdesrc/build/kdelibs.refresh-me % kdesrc-build
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: closing parenthesis in sentence
Git commit b8457e5b329cc525f43af66639a95e2580f02286 by Yuri Chornoivan. Committed on 28/08/2010 at 06:02. Pushed by ashark into branch 'docbook_historied_per_file'. closing parenthesis in sentence svn path=/trunk/KDE/kdesdk/doc/scripts/kdesrc-build/; revision=1169007 Original commit: d9c3c910 https://invent.kde.org/sdk/kdesrc-build/-/commit/d9c3c91087acf766b54298dfad3a213448124c6f M +1-1doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/b8457e5b329cc525f43af66639a95e2580f02286 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 3e64fdc3..7a3e1e0f 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -164,7 +164,7 @@ Do not automatically install packages after they are built. This option explicitly disables skipping the build process (an optimization controlled by the build-when-unchanged option. This is +linkend="conf-build-when-unchanged">build-when-unchanged option). This is useful for making run the build when you have changed something that cannot check.
[sdk/kdesrc-build/docbook_historied_per_file] doc/using-kdesrc-build: Add missing parenthesis
Git commit 1aadb3aa66e3e7ab310702e9ddac0e4118b0acec by Yuri Chornoivan. Committed on 16/03/2014 at 09:59. Pushed by ashark into branch 'docbook_historied_per_file'. Add missing parenthesis Original commit: db494368 https://invent.kde.org/sdk/kdesrc-build/-/commit/db4943687395973c7efb57b92a3129ce41921e28 M +1-1doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/1aadb3aa66e3e7ab310702e9ddac0e4118b0acec diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index 62a2b38b..00f0d335 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -354,7 +354,7 @@ 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. +instead).
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Make make-install-prefix a common option again.
Git commit 8ed5d473134916ae8bf90ccb9c67f0f2503bb6f9 by Michael Pyne. Committed on 31/05/2014 at 21:42. Pushed by ashark into branch 'docbook_historied_per_file'. Make make-install-prefix a common option again. I had made some build-system related options not automatically apply to modules with customized build systems (e.g. Qt, CMake, "custom"). But this seems like the kind of option we'd want to have in common, as noted in a bug report to me by Andre Wöbbeking, so make make-install-prefix apply to all build systems by default if it's a global option. This can, of course, still be overridden for individual modules or module-sets. Original commit: 4a949962 https://invent.kde.org/sdk/kdesrc-build/-/commit/4a949962c6bf45876769e7a4f1048ebe95d1b756 M +1-1doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/8ed5d473134916ae8bf90ccb9c67f0f2503bb6f9 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 94c0d724..02f43429 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -625,7 +625,7 @@ generated by the script. make-install-prefix -Module setting overrides global (build system option) +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 install command used to install modules. This is useful for installing packages with for example, but
[sdk/kdesrc-build/docbook_historied_per_file] doc: Update kdesvn-build documentation to account for option changes
Git commit 9d4aab1b90af37d371bf79bd45f74f96ff067e62 by Michael Pyne. Committed on 09/08/2008 at 23:04. Pushed by ashark into branch 'docbook_historied_per_file'. Update kdesvn-build documentation to account for option changes svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=844547 Original commit: 8611c4ad https://invent.kde.org/sdk/kdesrc-build/-/commit/8611c4ada08b1686fc40141841ec089540bed797 M +0-6doc/features/features-overview.docbook M +2-2doc/index.docbook M +6-9doc/kde-cmake/kde-cmake-intro.docbook M +15 -20 doc/kdesvn-buildrc/index.docbook M +0-48 doc/using-kdesvn-build/developer-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/9d4aab1b90af37d371bf79bd45f74f96ff067e62 diff --git a/doc/features/features-overview.docbook b/doc/features/features-overview.docbook index 51245bf7..0c090070 100644 --- a/doc/features/features-overview.docbook +++ b/doc/features/features-overview.docbook @@ -7,12 +7,6 @@ - -For developers: Supports building the API -documentation for a module. Note that this only works for 3 -modules when not using the script. - - Supports output message levels ranging from being very quiet to a full debug level. diff --git a/doc/index.docbook b/doc/index.docbook index 6fde3060..2d4a889a 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -112,8 +112,8 @@ -2008-01-14 -1.6 +2008-08-09 +1.6.3 is a script which builds and installs directly from the sources found in the repository. diff --git a/doc/kde-cmake/kde-cmake-intro.docbook b/doc/kde-cmake/kde-cmake-intro.docbook index e2c0680b..9056daa3 100644 --- a/doc/kde-cmake/kde-cmake-intro.docbook +++ b/doc/kde-cmake/kde-cmake-intro.docbook @@ -6,28 +6,25 @@ beat out several competitors and was selected to be the build system for 4 autotools-based system that has used from the beginning. A introduction to page is available on the http://wiki.kde.org/tiki-index.php?page=KDECMakeIntro;> Wiki. +url="http://techbase.kde.org/Development/Tutorials/CMake;> TechBase. Basically, instead of running make -f Makefile.cvs, then configure, then (or ), we simply run and then . - has initial support for . A few features of + has support for . A few features of were really features of the underlying buildsystem, including inst-apps, configure-flags, and do-not-compile. When equivalent features are available, they are provided. For instance, the equivalent to the -configure-flags option is cmake-options. +configure-flags option is cmake-options, and the +do-not-compile option is also supported for +as of version 1.6.3. -However, some options, like inst-apps or do-not-compile, have no direct +However, some options (like inst-apps) have no direct equivalent, and are disabled. Should I find a way to implement them with I will do so and re-enable the option. However, more or less everything works the same. -Not all of has been ported to use at this point. For example, -the apidox option is rather useless until the -equivalent infrastructure is ready. I have tried to warn about such things but -not all deficiencies may be caught by for now. - diff --git a/doc/kdesvn-buildrc/index.docbook b/doc/kdesvn-buildrc/index.docbook index 83e3f66e..1b33e318 100644 --- a/doc/kdesvn-buildrc/index.docbook +++ b/doc/kdesvn-buildrc/index.docbook @@ -43,7 +43,6 @@ authors using the address you can find above. -apidox, to build API Documentation. apply-qt-patches, to enhance qt-copy. async, to update and build at the same time. binpath, to set the PATH variable. @@ -101,17 +100,13 @@ as well. apidox Overrides global - -Set this option to true in order to have automatically -build and install the API documentation for the module after the normal build/install -process. This only works for modules where make apidox does something, -including kdelibs, kdebase and koffice, among others. - -This option does not work for modules using support, due to -deficiencies in the build system. This option does not work for - 4 modules because the required build system support has been migrated to -a different program which has not been corrected to use yet. - +This option was used to allow for building KDE module API documentation. +It was removed in 1.6.3 due to it not being supported in KDE 4. Online +API documentation is available from http://api.kde.org/;>kde.org. +In addition it is possible to build KDE 4's API documentation using a script included in +the kdesdk module (/scripts directory). See http://techbase.kde.org/Development/Tools/apidox;>KDE +TechBase for more details. It is still possible to manually build API documentation +for older modules of course. @@ -220,7 +215,7 @@ for all 4 modules, since they use to build. Since these options are passed directly to the command line, they should be given as they would be typed into . For example: - cmake-options -DRPATH_STYLE=default +
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: doc: Improve rc-file layout documentation.
Git commit 7007b74dca24ce9aa44ee2d545ff1d3d92e59f34 by Michael Pyne. Committed on 08/09/2011 at 02:15. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Improve rc-file layout documentation. Really this was mostly an excuse to document the new "include" feature. Original commit: 2d0f0bf6 https://invent.kde.org/sdk/kdesrc-build/-/commit/2d0f0bf661aebb7f5ed487c7253fde1a38bc8790 M +84 -14 doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/7007b74dca24ce9aa44ee2d545ff1d3d92e59f34 diff --git a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook index 33fe1c66..8db8c20f 100644 --- a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook +++ b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook @@ -7,8 +7,15 @@ To use the script, you must have a file in your home directory called like to download and build. + +Layout of the configuration file + + +Global configuration + -It starts with the global options, specified like the following: +The configuration file starts with the global options, specified like the +following: @@ -18,24 +25,91 @@ global end global + + +Module configuration + -It is then followed by one or more module sections, specified like the -following: +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 repository (for example, kdeartwork or +kde-wallpapers), although it is possible to get around this if you manually +specify the URL. + -module-name must be a module from the repository (for -example, kdelibs or kdebase). Some options override global options, some -add to global options, and some global options simply cannot be overridden. +For Git modules, the module name can be essentially whatever you'd like, as +long as it does not duplicate any other module name in the configuration. Keep +in mind the source and build directory layout will be based on the module name +if you do not use the dest-dir option. +However, for Git module sets the +module-names must correspond with actual git modules +in the chosen repository. See git-repository-base or use-modules for more information. + + + + + + +Including other configuration files + + +Within the configuration file, you may reference other files by using the +include keyword with a file, which will act as if the file +referenced had been inserted into the configuration file at that point. + + +For example, you could have something like this: + +global +include ~/common-kdesrc-build-options + +# Insert specific options here. + +end global + + + + + + +Commonly used configuration options + The following is a list of commonly-used options. Click on the option to find out more about it. To see the full list of options, see @@ -43,18 +117,14 @@ option to find out more about it. To see the full list of options, see -branch, to checkout from a branch instead of /trunk. -build-dir, to set the directory to build in. cmake-options to define what flags to configure a module with using . -configure-flags to define what flags to configure a module with. -cxxflags to define the CXXFLAGS variable. +branch, to checkout from a branch instead of /trunk (for ) or master (for Git). +configure-flags to define what flags to configure with. kdedir, to set the directory to install to. -kde-languages, to set the translation packages to download and install. -make-options, to pass options to the program. +make-options, to pass options to the program (such as number of CPUs to use). qtdir, to set the path to . -set-env, to set an environment variable. source-dir, to change where to download the source code to. -svn-server, to change the server the sources are downloaded from. +
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Fix typos
Git commit 15842995b15afe6706a696abfa592e1e63503a59 by Yuri Chornoivan. Committed on 23/12/2013 at 16:17. Pushed by ashark into branch 'docbook_historied_per_file'. Fix typos Original commit: 49033a7d https://invent.kde.org/sdk/kdesrc-build/-/commit/49033a7dc322920c17c07aa339fe12b356f3f2a6 M +5-5doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/15842995b15afe6706a696abfa592e1e63503a59 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 867208b1..94ca9119 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -490,12 +490,12 @@ on also use that proxy server, if possible, by setting the 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. Fir example: -source/extragear/network/telepathy/ktp-text-ui +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 you need to set this -option to true +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 1.16.
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: kde-projects: Add --no-metadata command line option.
Git commit f8204c946cd23fd2a13afb5c09926af356f0d17f by Michael Pyne. Committed on 15/03/2014 at 22:51. Pushed by ashark into branch 'docbook_historied_per_file'. kde-projects: Add --no-metadata command line option. BUG:331939 FIXED-IN:1.16 Original commit: 900a08a7 https://invent.kde.org/sdk/kdesrc-build/-/commit/900a08a7d8421452be08d0e0967d46975541cb21 M +12 -0doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/f8204c946cd23fd2a13afb5c09926af356f0d17f diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index d5efcb87..b838a4ca 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -158,6 +158,18 @@ Skip the build process. + +--no-metadata + +Do not automatically download the extra metadata needed for 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 since the +metadata does not change very often. + + + --no-install
[sdk/kdesrc-build/docbook_historied_per_file] doc: Some touchups to the kdesvn-build documentation.
Git commit 6a568759b694f650bd83e15e6fda9e281bcb289f by Michael Pyne. Committed on 15/01/2008 at 03:43. Pushed by ashark into branch 'docbook_historied_per_file'. Some touchups to the kdesvn-build documentation. svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=761539 Original commit: 5087dbc4 https://invent.kde.org/sdk/kdesrc-build/-/commit/5087dbc4ef7ae60c88b503e0479e575e7cce97b0 M +6-0doc/features/features-overview.docbook M +3-2doc/getting-started/before-building.docbook M +7-0doc/getting-started/index.docbook M +3-2doc/index.docbook M +13 -1doc/kdesvn-buildrc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/6a568759b694f650bd83e15e6fda9e281bcb289f diff --git a/doc/features/features-overview.docbook b/doc/features/features-overview.docbook index 5c47b7d5..51245bf7 100644 --- a/doc/features/features-overview.docbook +++ b/doc/features/features-overview.docbook @@ -31,6 +31,12 @@ use on your computer. anonymous 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) + + Has excellent support for the qt-copy module, including optionally applying bugfix and optimization patches to the qt-copy diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook index 8ef9df41..3a151cc0 100644 --- a/doc/getting-started/before-building.docbook +++ b/doc/getting-started/before-building.docbook @@ -29,7 +29,8 @@ in order to prepare and use the system installation correctly. strategy) you must install the development tools and libraries needed for . The complete list of required tools can be found from the http://www.kde.org/info/requirements/3.5.php;> Compilation -Requirements page. +Requirements page. Requirements for the 4 series may be obtained +from the http://techbase.kde.org/;>KDE TechBase. Here is a list of some of the things you will need: @@ -39,7 +40,7 @@ Requirements page. version 2.57, or higher. ( 3 only) - 2.4.5, or higher. + 2.4.7, or higher. The client program, including support for Secure HTTP (https). To ensure needed support, you can run diff --git a/doc/getting-started/index.docbook b/doc/getting-started/index.docbook index 67dc943f..a40d5328 100644 --- a/doc/getting-started/index.docbook +++ b/doc/getting-started/index.docbook @@ -18,6 +18,13 @@ about packaging tools and requirements, common compilation pitfalls and strategies and information about running your new installation. + +In addition, the http://techbase.kde.org/;> TechBase +wiki maintains a procedure for http://techbase.kde.org/index.php?title=Getting_Started/Build/KDE4;>building + from source code. + + diff --git a/doc/index.docbook b/doc/index.docbook index fb25393a..6fde3060 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -100,6 +100,7 @@ 2006 2007 +2008 Michael Pyne @@ -111,8 +112,8 @@ -2007-05-01 -1.4 +2008-01-14 +1.6 is a script which builds and installs directly from the sources found in the repository. diff --git a/doc/kdesvn-buildrc/index.docbook b/doc/kdesvn-buildrc/index.docbook index 915fac8c..83e3f66e 100644 --- a/doc/kdesvn-buildrc/index.docbook +++ b/doc/kdesvn-buildrc/index.docbook @@ -271,7 +271,11 @@ set the environment variable CXXFLAGS during the build process. 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. +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. @@ -487,6 +491,14 @@ lower a priority will set for itself. The default is 10. + +no-svn +Overrides global +If this option is set to true then 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 Overrides global
[sdk/kdesrc-build/docbook_historied_per_file] doc: doc: Correct docs for changes to arbitrary global cmdline flags.
Git commit 8c4c2c96c734a41185716c440ff9634bcdf7a5eb by Michael Pyne. Committed on 26/01/2014 at 05:11. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Correct docs for changes to arbitrary global cmdline flags. This was changed in the recent refactor, now the docs should be up-to-date. BUG:330387 Original commit: 2f52754d https://invent.kde.org/sdk/kdesrc-build/-/commit/2f52754d9547aeb283811fb0021497c972814622 M +13 -3doc/cmdline/supported-cmdline-params.docbook M +3-2doc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/8c4c2c96c734a41185716c440ff9634bcdf7a5eb diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 19a94467..c5b53460 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -413,17 +413,27 @@ with it if it is needed. ---option-name= +--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 , that are not already supported by relevant command line +options. For example the async configuration +file option has specific --async and --no-async command line options that are +preferred by . + + + ---module-name,option-name= +--set-module-value-option=module-name,option-name,option-value You can use this option to override an option in your configuration file for a specific module. diff --git a/doc/index.docbook b/doc/index.docbook index 54285e39..a1c4a828 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -2,7 +2,7 @@ +Copyright (c) 2005-2008, 2010-2014 Michael Pyne Copyright (c) 2005 Carlos Leonhard Woelz Copyright (c) 2009 Burkhard Lück @@ -130,6 +130,7 @@ 2011 2012 2013 +2014 Michael Pyne @@ -140,7 +141,7 @@ -2013-02-19 +2014-01-25 1.16
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Adds ignore-kde-structure as an option
Git commit 0639f9dba432c7c18f6e0641c4290f63e4d04261 by Àlex Fiestas. Committed on 23/12/2013 at 15:37. Pushed by ashark into branch 'docbook_historied_per_file'. Adds ignore-kde-structure as an option Adds ignore-kde-structure option which will fetch and compile all projects in the same dir, meaning that instead of: extragear/network/kde-telepathy/ktp-text-ui it would be just ktp-text-ui Original commit: 34407904 https://invent.kde.org/sdk/kdesrc-build/-/commit/3440790441d0aa649657ddb5cfc46fe422187857 M +15 -0doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/0639f9dba432c7c18f6e0641c4290f63e4d04261 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 1b9a7701..867208b1 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -486,6 +486,21 @@ on also use that proxy server, if possible, by setting the + +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. Fir 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 you need to set this +option to true + +This option was introduced with 1.16. + + + ignore-modules Can't be overridden
[sdk/kdesrc-build/docbook_historied_per_file] doc: Some fixes to make the "skipping build" feature hopefully more useful:
Git commit 9aee3f12a3aaded1d016426bad966bfd41712683 by Michael Pyne. Committed on 28/08/2010 at 02:28. Pushed by ashark into branch 'docbook_historied_per_file'. Some fixes to make the "skipping build" feature hopefully more useful: * It is now controlled by an option 'build-when-unchanged' which defaults to true, so the optimization must now be explicitly enabled. * The build is only skipped if the module was successfully installed (as determined by the persistent data recorded last run). * A command-line option, --force-build is added, along with --no-build-when-unchanged to be symmetric with the rc-file option. The new command line option and rc-file option are also documented and added to the Kate/Kwrite syntax highlighting file. BUG:248826 FIXED-IN:1.12.1 svn path=/trunk/KDE/kdesdk/doc/scripts/kdesrc-build/; revision=1168981 Original commit: 142c7911 https://invent.kde.org/sdk/kdesrc-build/-/commit/142c79caa8b2473fd93cfe2af2a905b7fbf2 M +15 -0doc/cmdline/supported-cmdline-params.docbook M +26 -0doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/9aee3f12a3aaded1d016426bad966bfd41712683 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 84096a9a..3e64fdc3 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -158,6 +158,21 @@ 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 run the build when you have changed something +that cannot check. + +--force-build performs the exact same function, and +is perhaps easier to remember. + + + --debug diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 55b53bb2..fdf70245 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -124,6 +124,32 @@ Perhaps surprisingly, this option can be changed per module. + +build-when-unchanged +Module setting overrides global +Use this option in order to control whether always +tries to build a module that has not had any source code updates. + +By setting build-when-unchanged to +true, 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 build-when-unchanged to +false, 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 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-copy 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
[sdk/kdesrc-build/docbook_historied_per_file] doc: Remove purge-old-logs cmdline option.
Git commit 1fc2d01c53fc15daf08f6bf85595e121acd8 by Michael Pyne. Committed on 07/09/2011 at 20:13. Pushed by ashark into branch 'docbook_historied_per_file'. Remove purge-old-logs cmdline option. The option can actually still be passed since kdesrc-build accepts command-line options matching known global option names, but since we default to removing old log directories there's no reason to add 40 different ways to enable this. Original commit: 7643ae2f https://invent.kde.org/sdk/kdesrc-build/-/commit/7643ae2f36465f1d824a61dd9c042352ee49022b M +0-10 doc/cmdline/supported-cmdline-params.docbook M +1-10 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/1fc2d01c53fc15daf08f6bf85595e121acd8 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 6cbfc376..cbf3599c 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -339,16 +339,6 @@ the last run). ---purge-old-logs - -This option causes to delete unneeded log directories after -the build, to save disk space. All log directories that are not needed to -satisfy a link from log/latest will be deleted. This is disabled -by default. To enable this option by default, see the purge-old-logs -option. - - - --no-snapshots Supplying this option causes to always perform a normal initial diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 131dea70..224db878 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -537,16 +537,7 @@ where the KDE Platform libraries are installed, such as if you were using purge-old-logs Module setting overrides global This option controls whether old log directories are automatically -deleted or not. The default value is false. - -Even if you have not set this option to true, you can manually purge the -old log directories by running: - -kdesrc-build --no-src --no-build --purge-old-logs -kdelibs - -You can use any module name in the above command line, it does not have -to be kdelibs. +deleted or not. The default value is true.
[sdk/kdesrc-build/docbook_historied_per_file] doc/using-kdesrc-build: doc: Remove kde-qt from qt-copy docs
Git commit 7f7951339abe9d0bc8b6c4ca2ebeab650fc77fdf by Michael Pyne. Committed on 07/09/2011 at 20:48. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Remove kde-qt from qt-copy docs Original commit: 2c828f71 https://invent.kde.org/sdk/kdesrc-build/-/commit/2c828f713661c63b5fb81e5efc67364814f463eb M +12 -11 doc/using-kdesrc-build/basic-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/7f7951339abe9d0bc8b6c4ca2ebeab650fc77fdf diff --git a/doc/using-kdesrc-build/basic-features.docbook b/doc/using-kdesrc-build/basic-features.docbook index e47be3d8..7be43029 100644 --- a/doc/using-kdesrc-build/basic-features.docbook +++ b/doc/using-kdesrc-build/basic-features.docbook @@ -25,19 +25,20 @@ linkend="conf-repository">repository option and branch options are set appropriately: -The first option is to build with a grouping of recommended bug -fix and optimization patches applied (this used to be controlled using an -option called apply-patches). This collection is developed in a separate -repository at http://gitorious.org/+kde-developers/qt/kde-qt;>http://gitorious.org/+kde-developers/qt/kde-qt. -If you would like to build with patches applied (most developers do) then -you should set your repository option to -git://gitorious.org/+kde-developers/qt/kde-qt.git +The first option is to build using a mirror maintained +on the 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 module from its official repository. + +You can set the repository option for the qt-copy +module to kde:qt to use this option. -Otherwise, to build the standard , set your repository -option to -git://gitorious.org/qt/qt.git +Otherwise, to build the standard , set your +repository option to +git://gitorious.org/qt/qt.git. Note that you may +experience problems performing the initial clone of from this +repository. In both cases, the branch option should be set to master (unless you'd
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: doc: Add related cli options to the config options table
Git commit f42ffd21926b310715e8ab7ccd0c4dc850380f82 by Andrew Shark.
Committed on 24/01/2024 at 22:36.
Pushed by ashark into branch 'docbook_historied_per_file'.
doc: Add related cli options to the config options table
Original commit: 54b5af83
https://invent.kde.org/sdk/kdesrc-build/-/commit/54b5af830ceb16b844a81b4707cb3e5a9ac943ef
M +63 -8doc/kdesrc-buildrc/conf-options-table.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/f42ffd21926b310715e8ab7ccd0c4dc850380f82
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook
b/doc/kdesrc-buildrc/conf-options-table.docbook
index e19ac4d0..0573f12d 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -40,7 +40,9 @@ option.
This option enables the asynchronous mode of operation, where the source
code update and the build process will be performed in parallel, instead of
waiting for
-all of the source code updates before starting the build
process.
+all of the source code updates before starting the build process.
+Related command-line option:
+
@@ -52,6 +54,7 @@ all of the source code updates before starting the build
process.
Note that will not output the
color codes to anything but a terminal (such as xterm, , or the normal
console).
+Related command-line option:
@@ -67,6 +70,7 @@ color codes to anything but a terminal (such as xterm,
, or the normal
make sure that if you are using ssh-agent, it is actually managing some
identities. This is to try and prevent from asking for your pass phrase
for every module.
+Related command-line option: --disable-agent-check,
--no-disable-agent-check
@@ -137,6 +141,7 @@ also disabled.
unless you also pass the --delete-my-settings
command-line option.
+Related command-line option: --install-environment-driver,
--no-install-environment-driver
@@ -167,6 +172,7 @@ option to false. If enabled,
this feature also enabl
unless you also pass the --delete-my-settings
command-line option.
+Related command-line option: --install-session-driver,
--no-install-session-driver
@@ -180,6 +186,7 @@ command-line option.
Set this option to a number between 20 and 0. The higher the number, the
lower a priority will set for itself, i.e. the higher the
number, the "nicer" the program is.
+Related command-line option:
@@ -198,6 +205,7 @@ number of CPUs, this value is set to 4.
See for an example of this
option's usage.
+Related command-line option: --num-cores
value
@@ -225,6 +233,7 @@ any module in the same way that num-cores
is used.
If cannot detect available memory then this value will be
set to 2.
+Related command-line option: --num-cores-low-mem
value
@@ -245,6 +254,7 @@ be saved to
~/.local/state/kdesrc-build-data
configurations in the same directory, you may want to manually set this option,
so that different configurations do not end up with conflicting persistent
data.
+Related command-line option: --persistent-data-file
file
@@ -273,6 +283,7 @@ linkend="ssh-agent-reminder"/>.
Use lower priority for disk and other I/O, which can significantly
improve the
responsiveness of the rest of the system at the expense of slightly longer
running times for .
+Related command-line option: --use-idle-io-priority,
--no-use-idle-io-priority
@@ -284,6 +295,7 @@ running times for .
Default valueFalse
Allow kdesrc-build to also clone and pull from repositories marked as
inactive.
+Related command-line option: --use-inactive-modules,
--no-use-inactive-modules
@@ -319,6 +331,7 @@ variable should include the colon-separated paths of your
development
toolchain. The paths ${install-dir}/bin
and
${qt-install-dir}/bin are automatically
added. You
may use the tilde (~) for any paths you add using this option.
+Related command-line option: --binpath
path
@@ -333,6 +346,7 @@ may use the tilde (~) for any paths you add using this
option.
For most modules you probably wish to use the branch-group option instead and use this
option for case-by-case exceptions.
+Related command-line option: --branch
value
@@ -369,6 +383,7 @@ modules (the common case). See also .
+Related command-line option: --branch-group
value
@@ -404,6 +419,7 @@
class="directory">/home/user-name/builddir.
Perhaps surprisingly, this option can be changed per module.
+Related command-line option: --build-dir
path
@@ -431,6 +447,7 @@ 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.
+Related command-line option:
@@ -450,7 +467,9 @@ as if unset.
Note that if a valid generator is also specified through
cmake-options it will override the
-value for cmake-generator.
+value for cmake-generator.
+Related command-line option: --cmake-generator
value
+
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesvn-buildrc: Be more descriptive about what is needed to get cxxflags to work in the Docbook documentation for kdesvn-build
Git commit 076c24f1da2f2cc4acf08fd764567c6adf0fd045 by Michael Pyne. Committed on 28/09/2008 at 04:10. Pushed by ashark into branch 'docbook_historied_per_file'. Be more descriptive about what is needed to get cxxflags to work in the Docbook documentation for kdesvn-build svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=865564 Original commit: d7b88456 https://invent.kde.org/sdk/kdesrc-build/-/commit/d7b884567084c3f7311c79eec124b769c27866ce M +7-3doc/kdesvn-buildrc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/076c24f1da2f2cc4acf08fd764567c6adf0fd045 diff --git a/doc/kdesvn-buildrc/index.docbook b/doc/kdesvn-buildrc/index.docbook index d65af538..57192b41 100644 --- a/doc/kdesvn-buildrc/index.docbook +++ b/doc/kdesvn-buildrc/index.docbook @@ -215,7 +215,7 @@ for all 4 modules, since they use to build. Since these options are passed directly to the command line, they should be given as they would be typed into . For example: - cmake-options -DKDE4_BUILD_TESTS=ON + cmake-options -DCMAKE_BUILD_TYPE=RelWithDebInfo Since this is a hassle, takes pains to ensure that as long @@ -252,12 +252,16 @@ color codes to anything but a terminal (such as xterm, , or the normal cxxflags Appends to global option -Use this option to specify what flags to pass to ./configure as the +Use this option to specify what flags to pass to ./configure as the CXXFLAGS when creating the build system for 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. +set the environment variable CXXFLAGS during the build process. + +Note that for 4 and any other modules that use , 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.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Add git-user option.
Git commit 7c2665eb90aafece2786217021586042c13ac24e by Michael Pyne. Committed on 12/09/2015 at 20:57. Pushed by ashark into branch 'docbook_historied_per_file'. Add git-user option. This option can be used to setup the user.name and user.email git-config options within each new git repository cloned or installed from snapshot, including kde-projects repositories. This can be useful for KDE developers with multiple Git identities that they use for development. Module settings override global settings so you could e.g. have a global git-user option for KDE modules and then override specific modules or module-sets with a different git-user setting. This setting is only applied during the initial git-clone process though... if there's interest in having kdesrc-build re-apply settings later that's possible too. BUG:352478 FIXED-IN:15.09 Original commit: 21b5eb93 https://invent.kde.org/sdk/kdesrc-build/-/commit/21b5eb9371fbb0f5f43f7cba7606c4bdb32fedd4 M +2-2doc/index.docbook M +31 -0doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/7c2665eb90aafece2786217021586042c13ac24e diff --git a/doc/index.docbook b/doc/index.docbook index cf157d6f..0f3a060a 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -142,8 +142,8 @@ -2015-03-07 -1.16 +2015-09-12 +15.09 is a script which builds and installs software diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 48606442..e1980d8d 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -471,6 +471,37 @@ different module sets. + +git-user +Module setting overrides global + +This option is intended for developers. If set, it will be used to +automatically setup identity information for the source control software +for newly downloaded modules (including the vast +majority of modules). + +Specifically, the user's name and email fields for each new repository are filled +in to the values set by this option. + +The value must be specified in the form User +Name em...@example.com. + + + +For instance, a developer named Foo Barbaz with the +email address f...@abc.xyz would use: + + +git-user Foo Barbaz f...@abc.xyz + + + + +This option was introduced in 15.09. + + + + http-proxy Module setting overrides global
[sdk/kdesrc-build/docbook_historied_per_file] doc: Allow ignoring modules from global config
Git commit 24f6b604e110113070dfef7e3d3951fbe55a1a2f by Andrew Shark. Committed on 28/01/2024 at 07:28. Pushed by ashark into branch 'docbook_historied_per_file'. Allow ignoring modules from global config This will let users to constantly ignore specified modules in global section, so they do not need to pass it in command line each time. Also, it will allow to ignore some defined modules that are not in any module set (for example, gpgme). BUG: 472917 Original commit: 66bff6dc https://invent.kde.org/sdk/kdesrc-build/-/commit/66bff6dc56039cc75bcc64bc5a7c6fb38f9b1e82 M +3-1doc/cmdline/supported-cmdline-params.docbook M +2-2doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/24f6b604e110113070dfef7e3d3951fbe55a1a2f diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 494a3363..7c4f8f31 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -53,7 +53,9 @@ 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). - + +Note that this option does not override ignore-modules config option in global section. Instead, it appends it. + diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 8722b1ae..ed52e6bc 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -1335,8 +1335,8 @@ installations. However this only works on build systems that support TypeString Available since1.16 -Currently can only be used in module-set, see https://bugs.kde.org/show_bug.cgi?id=472917;>Bug 472917. +This option can be used in global section and in module-sets. +Note that when specified in global section, cmdline option does not override this, but instead appends. Modules named by this option, which would be chosen by due to a use-modules option, are instead skipped entirely. Use this option when you want to build an entire
[sdk/kdesrc-build/docbook_historied_per_file] doc/using-kdesrc-build: doc: Create table of debug levels
Git commit ada8af00cd80e5f217cdb3999ae9382a5709ce12 by Andrew Shark. Committed on 24/02/2024 at 16:26. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Create table of debug levels Original commit: fd57dd66 https://invent.kde.org/sdk/kdesrc-build/-/commit/fd57dd6695550f522a2c2c16d09d1ca9bfee6ad1 M +52 -19 doc/using-kdesrc-build/other-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/ada8af00cd80e5f217cdb3999ae9382a5709ce12 diff --git a/doc/using-kdesrc-build/other-features.docbook b/doc/using-kdesrc-build/other-features.docbook index 96215a58..c42d97fe 100644 --- a/doc/using-kdesrc-build/other-features.docbook +++ b/doc/using-kdesrc-build/other-features.docbook @@ -6,25 +6,58 @@ has several options to control the amount of output the script generates. In any case, errors will always be output. - -The --quiet option (short form is --q) causes to be mostly silent. Only important -messages, warnings, or errors will be shown. When available, build progress -information is still shown. - -The --really-quiet option (no short form) -causes to only display important warnings or errors while it is -running. - -The --verbose option (short form is --v) causes to be very detailed in its -output. - -The --debug option is for debugging purposes -only, it causes to act as if --verbose was -turned on, causes commands to also output to the terminal, and will display -debugging information for many functions. - + + Table of debug levels + + + + + Debug level + Level name + Command line option + + + + + +0 +DEBUG +--debug + + + +1 +WHISPER +--verbose + + + +2 +INFO +Selected by default + + + +3 +NOTE +--quiet + + + +4 +WARNING +--really-quiet + + + +5 +ERROR +No way to select + + + + +
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Merge kdesrc-build --run and kdesrc-run
Git commit 9113a2a9a8b27dd9f70e812fa958367cfa9dcec6 by Andrew Shark.
Committed on 17/02/2024 at 17:50.
Pushed by ashark into branch 'docbook_historied_per_file'.
Merge kdesrc-build --run and kdesrc-run
This fixes multiple issues with kdesrc-run and kdesrc-build --run
When using the --run parameter, the environment variables of global module were
applied (from set-env options). But this is incorrect, since global cannot be
treated as usual module. Its build system is defined as generic. In its
prepareModuleBuildEnvironment these variables were setted:
- PKG_CONFIG_PATH
- LD_LIBRARY_PATH
- PATH
They have nothing to do with launched module's variables, except PATH, but even
that was because of global install-dir matches the module's install-dir in most
cases.
The kdesrc-run did sourced module's prefix.sh instead (located in its
build-dir). That setted the following variables:
- PATH (the correct, from module)
- XDG_DATA_DIRS
- XDG_CONFIG_DIRS
- QT_PLUGIN_PATH
- QML2_IMPORT_PATH
- QT_QUICK_CONTROLS_STYLE_PATH
This commit fixes the broken behavior of --run, and the broken behavior of
kdesrc-run.
Fixes: #145
Fixes: #114
Other fixes:
- Now the parameters after --run that starts with minuses are passed to the
start-program, and not considered as options of kdesrc-build
- When setting parameters to the runned executable, they are actually applied.
Previously the run script surrounded the $@ in the quotes.
- Fixed indentation and unnecessary semicolons in executable script.
- Made more clear note information when launching. The debug level controls if
it will be displayed.
Original commit: 301b9b4c
https://invent.kde.org/sdk/kdesrc-build/-/commit/301b9b4caf1b84bf2e14bd616fec06683f5a2d18
M +3-23 doc/cmdline/supported-cmdline-params.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/9113a2a9a8b27dd9f70e812fa958367cfa9dcec6
diff --git a/doc/cmdline/supported-cmdline-params.docbook
b/doc/cmdline/supported-cmdline-params.docbook
index fb02d2d3..2a8014b6 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -59,31 +59,11 @@ a few).
---run (or
--start-program) program [parameters
...]
+--run (or
--start-program) [-e|--exec name] [-f|--fork]
program [parameters ...]
This option interprets the next item on the command line as a program to run,
-and 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 environment
-in most cases however, since interactive shells typically reset at least part
-of the environment variables (such as PATH and
-${install-dir}) in the startup sequence.
-
-
-If you want to see the environment used by , 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.
-
-
+and will then finish reading the configuration file, source the
+prefix.sh to apply environment variables, and then execute the given
program.
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Use distro-dependencies defined in repo-metadata
Git commit 4d3784b2b6b8c2c67ac6ef0c6cd6d3ee2af47f5a by Andrew Shark. Committed on 18/02/2024 at 11:02. Pushed by ashark into branch 'docbook_historied_per_file'. Use distro-dependencies defined in repo-metadata Distro dependencies (data/pkg) moved here: https://invent.kde.org/sysadmin/repo-metadata/-/tree/master/distro-dependencies Original commit: 75bfc436 https://invent.kde.org/sdk/kdesrc-build/-/commit/75bfc43675938761ee0f23efa36ebbfd70ea0322 M +1-0doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/4d3784b2b6b8c2c67ac6ef0c6cd6d3ee2af47f5a diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 2a8014b6..25ccfc7c 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -558,6 +558,7 @@ software to run. --install-distro-packages --generate-config at the same time. +In kdesrc-build (perl implementation) it additionally uses "--install-distro-packages-perl".
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Cmdline: Use -M as short form of --no-metadata
Git commit c9e12ff425d114fc071eea9a2c17b91ee28d4671 by Andrew Shark. Committed on 14/02/2024 at 09:45. Pushed by ashark into branch 'docbook_historied_per_file'. Cmdline: Use -M as short form of --no-metadata Original commit: 6bcfb320 https://invent.kde.org/sdk/kdesrc-build/-/commit/6bcfb3205897b8d0b40f66e88f7ee155076f79e4 M +1-1doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/c9e12ff425d114fc071eea9a2c17b91ee28d4671 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 95367ed7..c3202192 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -358,7 +358,7 @@ kdepim: master ---no-metadata +--no-metadata (or -M) Do not automatically download the extra metadata needed for git modules. The source updates for the modules themselves will still occur unless you pass
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: query: Add module-set query mode
Git commit 8ed4a1a3ccd135c7bbf68acb03b9ab45694371f1 by Andrew Shark. Committed on 05/02/2024 at 15:28. Pushed by ashark into branch 'docbook_historied_per_file'. query: Add module-set query mode This can be used for example for querying all defined modules and module-sets, for preparing zsh autocompletion cache Original commit: abe4cf12 https://invent.kde.org/sdk/kdesrc-build/-/commit/abe4cf121e3691008de810105bb6f1e7901945b6 M +4-0doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/8ed4a1a3ccd135c7bbf68acb03b9ab45694371f1 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 4cb6e494..b52bf204 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -302,6 +302,10 @@ one of the following: linkend="conf-branch">branch and branch-group settings in effect. +module-set, which causes to +output the name of module-set which contains the module. This can be used +to generate zsh autocompletion cache. + Any option name that is valid for modules in the configuration file.
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Fix XML
Git commit c87bce363568a41f669a3edc2c20d140f1bc7a47 by Yuri Chornoivan. Committed on 29/01/2024 at 13:53. Pushed by ashark into branch 'docbook_historied_per_file'. Fix XML Original commit: 3f5708b4 https://invent.kde.org/sdk/kdesrc-build/-/commit/3f5708b4b27983980e3d4456af67c97e8789d048 M +1-1doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/c87bce363568a41f669a3edc2c20d140f1bc7a47 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 63adbf01..345ef74e 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -1300,8 +1300,8 @@ installations. However this only works on build systems that support - These options do not require any value (except "filter-out-phases"). They are applied if they are presented in a section. + Phase selection options
[sdk/kdesrc-build/docbook_historied_per_file] doc: Rename qtdir option to qt-install-dir
Git commit a3230652ba0ab05f2b2213515fe5f65565e80694 by Andrew Shark.
Committed on 17/01/2024 at 16:57.
Pushed by ashark into branch 'docbook_historied_per_file'.
Rename qtdir option to qt-install-dir
Also remove usage of ancient environment variable QTDIR, which is not used
today.
CC: #142
Original commit: 2a2f6fd7
https://invent.kde.org/sdk/kdesrc-build/-/commit/2a2f6fd7a956a3657908b91dfe074c544e954e74
M +6-7doc/appendix-profile/old-profile-setup.docbook
M +2-2doc/features/features-overview.docbook
M +0-1doc/index.docbook
M +7-7doc/kdesrc-buildrc/conf-options-table.docbook
M +1-1doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
M +1-6doc/using-kdesrc-build/basic-features.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/a3230652ba0ab05f2b2213515fe5f65565e80694
diff --git a/doc/appendix-profile/old-profile-setup.docbook
b/doc/appendix-profile/old-profile-setup.docbook
index 987925fe..8942b9fe 100644
--- a/doc/appendix-profile/old-profile-setup.docbook
+++ b/doc/appendix-profile/old-profile-setup.docbook
@@ -25,25 +25,24 @@ 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.
-PATH=${install-dir}/bin:$QTDIR/bin:$PATH
-MANPATH=$QTDIR/doc/man:$MANPATH
+PATH=${install-dir}/bin:${qt-install-dir}/bin:$PATH
+MANPATH=${qt-install-dir}/doc/man:$MANPATH
# Act appropriately if LD_LIBRARY_PATH is not already set.
if [ -z $LD_LIBRARY_PATH ]; then
- LD_LIBRARY_PATH=${install-dir}:/lib:$QTDIR/lib
+ LD_LIBRARY_PATH=${install-dir}:/lib:${qt-install-dir}/lib
else
- LD_LIBRARY_PATH=${install-dir}:/lib:$QTDIR/lib:$LD_LIBRARY_PATH
+ LD_LIBRARY_PATH=${install-dir}:/lib:${qt-install-dir}/lib:$LD_LIBRARY_PATH
fi
-export QTDIR PATH MANPATH LD_LIBRARY_PATH
+export PATH MANPATH LD_LIBRARY_PATH
or, if you are not building qt (and are using your system instead), add
this instead:
-PATH=${install-dir}/bin:$QTDIR/bin:$PATH
+PATH=${install-dir}/bin:${qt-install-dir}/bin:$PATH
# Act appropriately if LD_LIBRARY_PATH is not already set.
if [ -z $LD_LIBRARY_PATH ]; then
diff --git a/doc/features/features-overview.docbook
b/doc/features/features-overview.docbook
index 3f6c9de1..6637dc14 100644
--- a/doc/features/features-overview.docbook
+++ b/doc/features/features-overview.docbook
@@ -142,7 +142,7 @@ a base single-user installation from the anonymous
source repositories.
Tilde-expansion for your configuration options. For example, you can
specify:
-qtdir ~/kdesrc/build/qt
+install-dir ~/kde/usr
@@ -163,7 +163,7 @@ Forced full rebuilds, by running
You can specify various environment values to be used during the build,
-including QTDIR, DO_NOT_COMPILE,
+including DO_NOT_COMPILE
and CXXFLAGS.
diff --git a/doc/index.docbook b/doc/index.docbook
index a7dcc0d2..748187ca 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -39,7 +39,6 @@
configure-flags'>
install-dir'>
- qtdir'>
build-dir'>
source-dir'>
colorful-output'>
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook
b/doc/kdesrc-buildrc/conf-options-table.docbook
index 7ee10c94..be58e68b 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -316,8 +316,8 @@ running times for .
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 install-dir/bin and
-$QTDIR/bin are
automatically added. You
+toolchain. The paths ${install-dir}/bin
and
+${install-dir}/bin are automatically
added. You
may use the tilde (~) for any paths you add using this option.
@@ -811,7 +811,7 @@ in the path to have them expanded to the module's
name.
Default valueAuto detected
Set this option to change the default name of the installed library
directory
-inside ${install-dir} and $QTDIR. On many systems this is either
+inside ${install-dir} and ${qt-install-dir}. On many systems this is either
"lib" or "lib64". Auto-detection is attempted to set the correct name by
default,
but if the guess is wrong then it can be changed with this setting.
@@ -827,7 +827,7 @@ but if the guess is wrong then it can be changed with this
setting.
LD_LIBRARY_PATH while building. You cannot override this setting
in a module option. The default value is blank, but the paths ${install-dir}/$LIBNAME and
$QTDIR/$LIBNAME are
automatically added.
+class="directory">${qt-install-dir}/$LIBNAME are
automatically added.
You may use the tilde (~) for any paths you add using this option.
@@ -1033,13 +1033,13 @@ installs the module.
-
-qtdir
+
+qt-install-dir
TypeString
-Set this option to set the environment variable QTDIR
while building.
+This option controls where to install qt modules after build.
If you do not
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Fix git-repository-base option
Git commit 31ff822811e6823777de3f7a61e3eba980336ac9 by Andrew Shark. Committed on 26/01/2024 at 04:17. Pushed by ashark into branch 'docbook_historied_per_file'. Fix git-repository-base option Before this commit, only the last occurrence of this option was applied to the build context. Now we actually can use it several times in the global section, as it was intended. - The actual reading of 'git-repository-base' was done when constructing OptionBase from the global section of the config. - The merging options from the constructed OptionsBase object into the BuildContext was done in setOption of BuildContext, but because it was not properly handled in OptionsBase, only the last value was appeared in BuildContext's handling. - Now it is handled in the OptionsBase also when merging (we expect that the type of value is a hash then). - Remove incorrect placement of 'git-repository-base' to the checking of module-set option in the Module, so our BuildContex::setOption can call its parent class Module::setOption, which then can pass this option handling to its parent class OptionsBase::setOption. Also: - Move endWord suggestion next to the printed message. The actual endWord does not matter when parsing, so it makes code a bit more readable when understanding how it parses - Edit comment so it better explains why we remove some options that we read from the config - Move the config description in docbook to the correct scope Original commit: 56023880 https://invent.kde.org/sdk/kdesrc-build/-/commit/5602388099291523942b475b51a2f6a2334012af M +60 -59 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/31ff822811e6823777de3f7a61e3eba980336ac9 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 0573f12d..8722b1ae 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -108,6 +108,66 @@ protocol is most efficient. + +git-repository-base + + +TypeString +Available since1.12.1 + +This option 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 behaving as if it had read: + + +module module1 +repository kde:module1.git +end module + +module module2 +repository kde:module2.git +end module + + +The kde: repository prefix used above is a +shortcut which will be setup by automatically. See the TechBase +https://techbase.kde.org/Development/Git/Configuration#URL_Renaming;>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. + + + install-environment-driver @@ -1267,65 +1327,6 @@ installations. However this only works on build systems that support - -git-repository-base - - -TypeString -Available since1.12.1 - -This option 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 behaving as if it had read: - - -module module1 -repository kde:module1.git -end module - -module module2 -repository kde:module2.git -end module - - -The kde: repository prefix used above is a -shortcut which will be setup by automatically. See the TechBase -https://techbase.kde.org/Development/Git/Configuration#URL_Renaming;>URL -Renaming article for more information. Note that unlike most other -options, this option can be specified multiple times in order
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: doc: Group cli parameters to logical sections
Git commit 3665f792bc29c1072848f42671e7b62a27dda820 by Andrew Shark.
Committed on 07/01/2024 at 09:09.
Pushed by ashark into branch 'docbook_historied_per_file'.
doc: Group cli parameters to logical sections
- Indicate mandatory parameters of options.
- Add missing (undocumented) alternative option names
- Change semantic markup "parameter" -> "option" to differentiate with changing
part ("replaceable")
- Fix some grammar
The https://l10n.kde.org/docs/doc-primer/actions-and-commands.html does not
describe (at the moment of writing) the "parameter" tag for some reason.
Original commit: 5d7e870d
https://invent.kde.org/sdk/kdesrc-build/-/commit/5d7e870dd7658498d427451aed386a60063e0e80
M +495 -479 doc/cmdline/supported-cmdline-params.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/3665f792bc29c1072848f42671e7b62a27dda820
diff --git a/doc/cmdline/supported-cmdline-params.docbook
b/doc/cmdline/supported-cmdline-params.docbook
index f5c288dd..3114de5f 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -1,227 +1,254 @@
Supported command-line parameters
-
-The script accepts the following command-line options:
-
-
+
+Generic
-
---async
-
-Enables the asynchronous mode, which can
-perform the source code updates and module builds at the same time. This is
-the default, this option only needs specified if you have disabled it in the
-configuration.
-
-
-
-
---help (or -h)
+
+--pretend (or --dry-run or
-p)
-Only display simple help on this script.
-
-
+ 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.).
-
---version (or -v)
-
-Display the program version.
-
-
+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).
+
-
---show-info
-
-Displays information about 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.
+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 (and therefore, don't have
+this metadata), you should run kdesrc-build
+--metadata-only to download the required metadata
+first.
+
-
---initial-setup
+
+--include-dependencies (or -d),
--no-include-dependencies (or -D)
-Has perform the one-time initial setup necessary to prepare
-the system for to operate, and for the newly-installed
-software to run.
-
-This includes:
-
-Installing known dependencies (on supported
distributions)
-Adding required environment variables to
~/.bashrc
-Setting up a configuration
file
-
-This option is exactly equivalent to using
---install-distro-packages
---generate-config
---update-shellrc at the same
time.
-
-
-
+This option causes to automatically include other and
+modules in the build, if required for the modules you have requested to build
+on the command line or in your
+configuration file.
-
---install-distro-packages
-
-Installs distro packages (on supported distributions) necessary to
prepare the system for to operate, and for the newly-installed
-software to run.
-
-See also --initial-setup
+The modules that are added are as recorded within the source code
+management system. See .
+
+The corresponding configuration file option is
+include-dependencies.
+
+This option is enabled by default.
-
---generate-config
+
+--ignore-modules (or -!)
module [module ...]
-Generate the configuration file.
-
-See also --initial-setup
-
+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).
+
-
---update-shellrc
+
+--run (or --start-program)
program [parameters ...]
-Edit the "~/.bashrc" (or other shell rc file) to add to your
$PATH variable and enable autocompletion.
+This option interprets the next item on the command line as a program to run,
+and 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 environment
+in most cases however, since interactive shells typically reset at least part
+of the environment variables (such as PATH and
+${install-dir}) in the startup sequence.
-See also --initial-setup
+
+If you want to see the environment used by , 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.
+
+
-
---author
[sdk/kdesrc-build/docbook_historied_per_file] doc: doc: Add self links to the listed entries
Git commit ccfbc22e4e3b0bfeba955a8fe9c3b8cd40792806 by Andrew Shark. Committed on 16/01/2024 at 19:55. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Add self links to the listed entries Currently, the anchors are not rendered, see https://bugs.kde.org/show_bug.cgi?id=479910 To workaround, we will use links to the items itself, so users could easily copy and share the link to the option. Original commit: 4e0a8ad0 https://invent.kde.org/sdk/kdesrc-build/-/commit/4e0a8ad0db52e3f519214c740aa21ea7f0efa5c8 M +53 -53 doc/cmdline/supported-cmdline-params.docbook M +60 -60 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/ccfbc22e4e3b0bfeba955a8fe9c3b8cd40792806 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 219c9099..494a3363 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -6,7 +6,7 @@ ---pretend (or --dry-run or -p) +--pretend (or --dry-run or -p) will run through the update and build process, but instead of performing any actions to update or build, will instead output what the @@ -29,7 +29,7 @@ first. ---include-dependencies (or -d), --no-include-dependencies (or -D) +--include-dependencies (or -d), --no-include-dependencies (or -D) This option causes to automatically include other and modules in the build, if required for the modules you have requested to build @@ -47,7 +47,7 @@ management system. See . ---ignore-modules (or -!) module [module ...] +--ignore-modules (or -!) module [module ...] 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 @@ -57,7 +57,7 @@ a few). ---run (or --start-program) program [parameters ...] +--run (or --start-program) program [parameters ...] This option interprets the next item on the command line as a program to run, and will then finish reading the configuration file, update the @@ -86,7 +86,7 @@ QMAIL_CONTROLDIR=/var/qmail/control ---revision id +--revision id This option causes to checkout a specific numbered revision for each module, overriding any branch, @@ -99,7 +99,7 @@ compatibility with older scripts. ---delete-my-patches, --no-delete-my-patches +--delete-my-patches, --no-delete-my-patches This option is used to let delete source directories that may contain user data, so that the module can be re-downloaded. This would normally @@ -112,7 +112,7 @@ deleted). ---delete-my-settings, --no-delete-my-settings +--delete-my-settings, --no-delete-my-settings This option is used to let overwrite existing files which may contain user data. @@ -123,8 +123,8 @@ with it if it is needed. - ---option-name value + +--option-name value You can use this option to override an option in your configuration file for every module. For instance, to override the - ---set-module-option-value module-name,option-name,option-value + +--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. @@ -159,7 +159,7 @@ a specific module. ---resume-from (or --from or -f) module +--resume-from (or --from or -f) module This option is used to resume the build starting from the given module. You should not specify other module names on the command line. @@ -176,7 +176,7 @@ build. ---resume-after (or --after or -a) module +--resume-after (or --after or -a) module This option is used to resume the build starting after the given module. You should not specify other module names on the command line. @@ -195,7 +195,7 @@ module. ---resume +--resume This option can be used to run after it has had a build failure. @@ -211,7 +211,7 @@ building the modules you were building before, without fiddling with ---stop-before (or --until) module +--stop-before (or --until) module This option is used to stop the normal build process just before a module would ordinarily be built. @@ -224,7 +224,7 @@ then --stop-before moduleB would cau ---stop-after (or --to) module +--stop-after (or --to) module This option is used to stop the normal build process just after a module would ordinarily be built. @@ -237,7 +237,7 @@ then --stop-after moduleB would caus ---stop-on-failure, --no-stop-on-failure +--stop-on-failure, --no-stop-on-failure This option controls if the build will be aborted as soon as a failure occurs. Default behavior is --stop-on-failure. You may override it if you wish to press on with the rest of the modules in the build, @@ -248,7 +248,7 @@ See also the stop-on-failure configu ---rebuild-failures +--rebuild-failures Use this option to build only those modules which failed to build on a previous run. This is
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Add --show-options-specifiers option
Git commit d921bdd7368d4f95b9fc6f0c05f8e58988d286a4 by Andrew Shark. Committed on 15/01/2024 at 17:23. Pushed by ashark into branch 'docbook_historied_per_file'. Add --show-options-specifiers option Original commit: 35e68fb5 https://invent.kde.org/sdk/kdesrc-build/-/commit/35e68fb5b925ef438cf441ead6dce3285f0fdbc8 M +8-8doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/d921bdd7368d4f95b9fc6f0c05f8e58988d286a4 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 71993bdc..219c9099 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -704,14 +704,6 @@ Display the program version. - ---author - -Display contact information for the -author. - - - --help (or -h) @@ -728,6 +720,14 @@ prove useful in bug reports or when asking for help in forums or mailing lists. + +--show-options-specifiers + +Print the specifier lines (in the format that GetOpts::Long accepts) for all command line options supported by the script. +This may be used by developers, for example, for generating zsh autocompletion functions. + + +
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Check that all option names read from config are recognised
Git commit cafef6c2228c7f489ce18cc80da5008a796f0b97 by Andrew Shark.
Committed on 10/01/2024 at 09:26.
Pushed by ashark into branch 'docbook_historied_per_file'.
Check that all option names read from config are recognised
For every option name read from the config, we will check if it is in
`@all_possible_options` array. And if not, raise an exception.
To differentiate between normal config options and non-standard config options
(options with custom name defined by user), we will prepend non-standard
options with underscore. So users can still use this convenience feature.
Other changes of this commit:
- Allow substituting references to global options when they have underscore in
their name.
- Add ability to _use_ custom variable immediately after defining in global
section
- Fix end word typo in `t/data/kde-projects/kdesrc-buildrc-with-deps`.
- Temporary show a help message for the recently renamed option "kdedir".
Original commit: f99141ca
https://invent.kde.org/sdk/kdesrc-build/-/commit/f99141cadf12bbb7221ddc88ea6ce3e208b492df
M +19 -1doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/cafef6c2228c7f489ce18cc80da5008a796f0b97
diff --git a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
index d5c7e1e7..adebe815 100644
--- a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
+++ b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
@@ -92,7 +92,7 @@ linkend="conf-use-modules">use-modules for more
information.
option-value.
One modification that performs is that a sequence
-${name-of-option} is replaced
+"${name-of-option}" is
replaced
with the value of that option from the global configuration. This allows you
to reference the value of existing options, including options already set by
.
@@ -101,6 +101,24 @@ to reference the value of existing options, including
options already set by
To see an example of this in use, see
.
+You can also introduce your own non-standard global variables for
referencing them further in the config.
+To do this, your option name should be prepended with underscore symbol.
Example:
+
+Introducing your own global option for referencing later in
config
+
+global
+ _ver 6 # ← your custom variable (starting with underscore)
+ _kde ~/kde${_ver} # ← custom variable can contain another defined variable
+ source-dir ${_kde}/src # ← note that nested variable (_kde → _ver) is also
resolved
+end global
+
+options kdepim
+ log-dir /custom/path/logs${_ver} # ← you can use custom variable just like a
standard
+end options
+
+
+
+
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Add specification for configuration options
Git commit 3fca6a373cd094293c9f43dc69d010e9bfed7f8d by Andrew Shark. Committed on 29/11/2023 at 13:06. Pushed by ashark into branch 'docbook_historied_per_file'. Add specification for configuration options Original commit: d9a2fb13 https://invent.kde.org/sdk/kdesrc-build/-/commit/d9a2fb130cd9a096df5bc6ea182e36a66d814b9d M +419 -258 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/3fca6a373cd094293c9f43dc69d010e9bfed7f8d diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index df4ff911..5545dc53 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -20,53 +20,67 @@ option. Global scope only options - + -Option-name -Module - Global Behavior -Notes +Option name +Description async -Cannot be overridden -This option enables the asynchronous mode of operation, where the source + + +TypeBoolean +Default valueTrue +Available since1.6 + +This option enables the asynchronous mode of operation, where the source code update and the build process will be performed in parallel, instead of waiting for -all of the source code updates before starting the build process. This option defaults -to enabling asynchronous mode. To disable, set this option to false -This option is available since the 1.6 release. +all of the source code updates before starting the build process. colorful-output -Cannot be overridden -Set this option to false to disable the colorful output of . -This option defaults to true. Note that will not output the + +TypeBoolean +Default valueTrue +Set this option to false to disable the colorful output of . +Note that will not output the color codes to anything but a terminal (such as xterm, , or the normal - console). + console). disable-agent-check -Cannot be overridden -Normally if you are using to download the sources -(such as if you are using the git+ssh protocol), will try and + + +TypeBoolean +Default valueFalse + +If you are using to download the sources +(such as if you are using the git+ssh protocol), this option controls if will try and make sure that if you are using ssh-agent, it is actually managing some identities. This is to try and prevent from asking for your pass phrase -for every module. You can disable this check by setting -disable-agent-check to true. +for every module. git-desired-protocol -Cannot be overridden -This option only applies to modules from a + +TypeString +Default valuegit +History informationThis option was added in 1.16. Prior to 20.06 this option +was used to configure the fetch URL instead of the push URL. As of 20.06 +https is always used when updating KDE projects. + +This option only applies to modules from a project repository. What this option actually does is configure which network protocol to @@ -87,16 +101,17 @@ 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 1.16. Prior to 20.06 this option -was used to configure the fetch URL instead of the push URL. As of 20.06 -https is always used when updating KDE projects. git-repository-base -Cannot be overridden -This option, added in version 1.12.1, is used to create a short + + +TypeString +Available since1.12.1 + +This option 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. @@ -105,26 +120,21 @@ quickly declaring many Git modules to build. 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: +# 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 +# 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 @@ -132,11 +142,11 @@ internally, with behaving as if it had read: module module1 -repository kde:module1.git +repository kde:module1.git end module module module2 -repository kde:module2.git +repository kde:module2.git end module @@ -156,8 +166,12 @@ different module sets. ignore-modules -Can't be overridden -Modules named by this option, which would be chosen by + + +TypeString +Available since1.16 + +Modules named by this option, which would be chosen by due to a use-modules option, are instead skipped entirely. Use this
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Support phase selection individually for modules and module-sets
Git commit 68dbc8f847165e08fcd7559df8eefd7971d8a68b by Andrew Shark. Committed on 28/01/2024 at 21:24. Pushed by ashark into branch 'docbook_historied_per_file'. Support phase selection individually for modules and module-sets Previously we could only select phases globally from command line. They were applied to all modules. Sometimes user want to control phase selection for individual module. The clone is happening from the remote/origin by default. This becomes a problem when user is working with a local branch that is not presented in remote. For example, user may not have a developer account, or just does not want to upload his work even in work/user branch yet. He just wants kdesrc-build to not touch the sources of that module (while the other modules still be updated), and does not want to exclude module from build phase. Let's say user wants to work with `kio`, and testing it with `ark`. Previously, user could achieve this task by running `kdesrc-build` several times. Different quirks were needed. Example: - `kdesrc-build ark --include-dependencies` - build ark with dependencies (including kio) as normal - `...` - make changes to the kio project - `kdesrc-build kio --no-src --no-include-dependencies` - `kdesrc-build ark --include-dependencies --ignore-modules kio` After this commit user can specify the `no-src` option for the `kio` module, and then just run `kdesrc-build ark --include-dependencies`. The `kio` will not be updated in this process, but will not be excluded from build phase. BUG: 354796 Original commit: d8104fa8 https://invent.kde.org/sdk/kdesrc-build/-/commit/d8104fa8e9defa5b25f7eab538a7b0f2fc652e1d M +88 -14 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/68dbc8f847165e08fcd7559df8eefd7971d8a68b diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index ed52e6bc..63adbf01 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -1038,20 +1038,6 @@ end options - -no-src - - -TypeBoolean -Default valueFalse - -If this option is set to true then 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. -Related command-line option: - - - override-build-system @@ -1314,6 +1300,94 @@ installations. However this only works on build systems that support + +These options do not require any value (except "filter-out-phases"). They are applied if they are presented in a section. +Phase selection options + + + + +Option name +Scope +Description + + + + + +no-src +globalmodulemodule-setoptions + +Remove update phase. The other phases that were presented will still be processed. +Related command-line option: + + + + +no-install +globalmodulemodule-setoptions + +Remove install phase. The other phases that were presented will still be processed. +Related command-line option: + + + + +no-tests +globalmodulemodule-setoptions + +Remove test phase. The other phases that were presented will still be processed. +Related command-line option: --no-tests + + + + +no-build +globalmodulemodule-setoptions + +Remove build phase. The other phases that were presented will still be processed. +Related command-line option: + + + + +build-only +globalmodulemodule-setoptions + +If had build phase, remove any other phases. Otherwise, remove all phases. +Related command-line option: + + + + +install-only +globalmodulemodule-setoptions + +If had install phase, remove any other phases. Otherwise, remove all phases. +Related command-line option: + + + + +uninstall +globalmodulemodule-setoptions + +If had uninstall phase, remove any other phases. Otherwise, remove all phases. +Related command-line option: --uninstall + + + + +filter-out-phases +globalmodulemodule-setoptions + +Remove those phases that are listed (space separated) in this option. The other phases that were presented will still be processed. + + + + + + Module-set and global scope options
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: doc: Fix mistake in variable name
Git commit e07bf87b7abb766f394a1e68ea29a4724af4f884 by Andrew Shark.
Committed on 19/01/2024 at 01:34.
Pushed by ashark into branch 'docbook_historied_per_file'.
doc: Fix mistake in variable name
Original commit: 4d990277
https://invent.kde.org/sdk/kdesrc-build/-/commit/4d990277cfe27c0fdcab5e422a37654b01aa2740
M +1-1doc/kdesrc-buildrc/conf-options-table.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/e07bf87b7abb766f394a1e68ea29a4724af4f884
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook
b/doc/kdesrc-buildrc/conf-options-table.docbook
index be58e68b..e19ac4d0 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -317,7 +317,7 @@ 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 ${install-dir}/bin
and
-${install-dir}/bin are automatically
added. You
+${qt-install-dir}/bin are automatically
added. You
may use the tilde (~) for any paths you add using this option.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Rename option "kdedir" to "install-dir"
Git commit 266f2e3bf47a1bc20da87d3d8e9cc0a871f5e2cb by Andrew Shark.
Committed on 03/01/2024 at 18:43.
Pushed by ashark into branch 'docbook_historied_per_file'.
Rename option "kdedir" to "install-dir"
The kdedir is ambiguous, it is not clear if it is source, build or install dir.
The kdedir naming dates back to the 2003 era when you had to define KDEDIR to
define where KDE 3 was installed, just as QTDIR was used to define the location
of the Qt 3 install.
mpyne later added prefix for non-KDE modules and should have switched things
over afterwards but never got around to it.
By KDE SC 5 the requirement to use KDEDIR (or as it was by then, KDEDIRS) was
dropped in favor of searching PATH.
See
https://invent.kde.org/sdk/kdesrc-build/-/commit/2f7b9477b7d44a2f88c148846c8f80f6921fd4ef#note_839381
Original commit: e5c028cd
https://invent.kde.org/sdk/kdesrc-build/-/commit/e5c028cd18fa9f5e508e7b88d64033880eca7fa6
M +10 -14 doc/appendix-profile/old-profile-setup.docbook
M +1-1doc/cmdline/supported-cmdline-params.docbook
M +1-1doc/features/features-overview.docbook
M +1-1doc/getting-started/configure-data.docbook
M +1-1doc/index.docbook
M +6-6doc/kdesrc-buildrc/conf-options-table.docbook
M +1-1doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
M +0-5doc/using-kdesrc-build/basic-features.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/266f2e3bf47a1bc20da87d3d8e9cc0a871f5e2cb
diff --git a/doc/appendix-profile/old-profile-setup.docbook
b/doc/appendix-profile/old-profile-setup.docbook
index 1aa44da4..987925fe 100644
--- a/doc/appendix-profile/old-profile-setup.docbook
+++ b/doc/appendix-profile/old-profile-setup.docbook
@@ -26,37 +26,33 @@ 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/usr by default.
-KDEDIRS=$KDEDIR
-PATH=$KDEDIR/bin:$QTDIR/bin:$PATH
+PATH=${install-dir}/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
+ LD_LIBRARY_PATH=${install-dir}:/lib:$QTDIR/lib
else
- LD_LIBRARY_PATH=$KDEDIR/lib:$QTDIR/lib:$LD_LIBRARY_PATH
+ LD_LIBRARY_PATH=${install-dir}:/lib:$QTDIR/lib:$LD_LIBRARY_PATH
fi
-export QTDIR KDEDIRS PATH MANPATH LD_LIBRARY_PATH
+export QTDIR PATH MANPATH LD_LIBRARY_PATH
or, if you are not building qt (and are using your system instead), add
this instead:
-KDEDIR=(path to kdedir) # Such as ~/kde/usr by default.
-KDEDIRS=$KDEDIR
-PATH=$KDEDIR/bin:$QTDIR/bin:$PATH
+PATH=${install-dir}/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
+ LD_LIBRARY_PATH=${install-dir}/lib
else
- LD_LIBRARY_PATH=$KDEDIR/lib:$LD_LIBRARY_PATH
+ LD_LIBRARY_PATH=${install-dir}/lib:$LD_LIBRARY_PATH
fi
-export KDEDIRS PATH LD_LIBRARY_PATH
+export PATH LD_LIBRARY_PATH
@@ -80,7 +76,7 @@ variables in your .bash_profile:
XDG_CONFIG_DIRS="/etc/xdg"
-XDG_DATA_DIRS="${KDEDIR}/share:/usr/share"
+XDG_DATA_DIRS="${install-dir}/share:/usr/share"
export XDG_CONFIG_DIRS XDG_DATA_DIRS
@@ -102,7 +98,7 @@ Open the .xinitrc text file from the
home directory, or
create it if necessary. Add the line:
-exec ${KDEDIR}/bin/startkde
+exec ${install-dir}/bin/startkde
diff --git a/doc/cmdline/supported-cmdline-params.docbook
b/doc/cmdline/supported-cmdline-params.docbook
index c44823ad..f5c288dd 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -608,7 +608,7 @@ environment as normal, and then execute the given
program.
This will not work to start a shell with the 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.
+${install-dir}) in the startup sequence.
If you want to see the environment used by , you
diff --git a/doc/features/features-overview.docbook
b/doc/features/features-overview.docbook
index 937f2941..3f6c9de1 100644
--- a/doc/features/features-overview.docbook
+++ b/doc/features/features-overview.docbook
@@ -163,7 +163,7 @@ Forced full rebuilds, by running
You can specify various environment values to be used during the build,
-including KDEDIR, QTDIR,
DO_NOT_COMPILE,
+including QTDIR, DO_NOT_COMPILE,
and CXXFLAGS.
diff --git a/doc/getting-started/configure-data.docbook
b/doc/getting-started/configure-data.docbook
index 59021d25..a4019619 100644
--- a/doc/getting-started/configure-data.docbook
+++ b/doc/getting-started/configure-data.docbook
@@ -28,7 +28,7 @@ The default settings should be appropriate to perform a
-kdedir, which changes the
+install-dir, which
changes the
destination directory that your software is
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Add support for --no-build-when-unchanged
Git commit d8fb6b82a84f32232294ef35f16cf2f74f269474 by Andrew Shark. Committed on 16/01/2024 at 11:49. Pushed by ashark into branch 'docbook_historied_per_file'. Add support for --no-build-when-unchanged This option was mistakenly not marked as negatable. Adding the negatable form allows to override the `true` value set to this option from config. Fixes: #351 Original commit: fe8dbd69 https://invent.kde.org/sdk/kdesrc-build/-/commit/fe8dbd69e35a9367181fe5d27c10d25786f192a4 M +2-4doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/d8fb6b82a84f32232294ef35f16cf2f74f269474 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 86e35dbb..da8b7da1 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -417,13 +417,11 @@ class="directory">/home/user-name/builddir. Control whether always tries to build a module that has not had any source code updates. -By setting build-when-unchanged to -true, always attempts the build phase +If set to true, always attempts the build phase for a module, even if the module did not have any source code updates. With this value it will more likely lead to a correct build. -By setting build-when-unchanged to -false, will only attempt to run the +If set to false, 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 daily, or more frequently.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Split index.docbook to separate docbook files
Git commit 4e02da6ffdcd40d258a3d39a3b8c10937f62cb4a by Andrew Shark. Committed on 05/01/2024 at 19:02. Pushed by ashark into branch 'docbook_historied_per_file'. Split index.docbook to separate docbook files Original commit: ff360536 https://invent.kde.org/sdk/kdesrc-build/-/commit/ff360536e7dad4a5d58a8f51386aa4035d58bed2 M +4-0doc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/4e02da6ffdcd40d258a3d39a3b8c10937f62cb4a diff --git a/doc/index.docbook b/doc/index.docbook index 64dc254d..a7dcc0d2 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -63,6 +63,10 @@ --resume-after'> --reconfigure'> --refresh-build'> + +
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: doc: Remove final paragraph about the selectors
Git commit 5c755544cb012cb250e543f1214d21958eb8961d by Andrew Shark. Committed on 08/01/2024 at 21:42. Pushed by ashark into branch 'docbook_historied_per_file'. doc: Remove final paragraph about the selectors The previous commit wrongly moved this paragraph to the specific section, but it was intentional to keep it outside the specific sections. However, this paragraph originates from the very initial lifetime of the index.docbook, and is no more accurate. So remove it. Original commit: cb3a389d https://invent.kde.org/sdk/kdesrc-build/-/commit/cb3a389d27de1f1ca8fe1e529435fe73ad35e3d4 M +0-5doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/5c755544cb012cb250e543f1214d21958eb8961d diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index f27563dd..ab7923bc 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -731,10 +731,5 @@ prove useful in bug reports or when asking for help in forums or mailing lists. - -Any other command-line options are assumed to be modules to update and build. -Please, do not mix building with installing. - -
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Fix XML and minor typos
Git commit d1f31832049cbacbb3fd1c9e45025ffa43ea532f by Yuri Chornoivan. Committed on 08/01/2024 at 08:31. Pushed by ashark into branch 'docbook_historied_per_file'. Fix XML and minor typos Original commit: 70d00640 https://invent.kde.org/sdk/kdesrc-build/-/commit/70d00640fd642476dd6904b311e1cf9e96c72a9b M +3-3doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/d1f31832049cbacbb3fd1c9e45025ffa43ea532f diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 3114de5f..f27563dd 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -165,7 +165,7 @@ specify other module names on the command line. If you want to avoid source updates -when resuming, simply pass --no-src +when resuming, simply pass --no-src in addition to the other options. @@ -572,7 +572,7 @@ Enable or disable colorful output. By default, this option is enabled for intera ---nice (or --niceness)value +--nice (or --niceness) value This value adjusts the computer CPU priority requested by , and should be in the range of 0-20. 0 is highest priority (because it is the @@ -730,11 +730,11 @@ prove useful in bug reports or when asking for help in forums or mailing lists. - Any other command-line options are assumed to be modules to update and build. Please, do not mix building with installing. +
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Move the module-set scope options to their table
Git commit 3ef19771ab890c89fbc6cdb5bf32e2f259f1c9a1 by Andrew Shark. Committed on 12/12/2023 at 09:53. Pushed by ashark into branch 'docbook_historied_per_file'. Move the module-set scope options to their table Original commit: 4ef24d2f https://invent.kde.org/sdk/kdesrc-build/-/commit/4ef24d2f1150cb209f9d9c97cfef415f7dd0f69d M +93 -90 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/3ef19771ab890c89fbc6cdb5bf32e2f259f1c9a1 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 2f26df6f..04faa8a4 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -104,95 +104,6 @@ protocol is most efficient. - -git-repository-base - - -TypeString -Available since1.12.1 - -This option 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 behaving as if it had read: - - -module module1 -repository kde:module1.git -end module - -module module2 -repository kde:module2.git -end module - - -The kde: repository prefix used above is a -shortcut which will be setup by automatically. See the TechBase -https://techbase.kde.org/Development/Git/Configuration#URL_Renaming;>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. - - - - -ignore-modules - - -TypeString -Available since1.16 - -Modules named by this option, which would be chosen by -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 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 . - - - install-environment-driver @@ -1302,7 +1213,7 @@ installations. However this only works on build systems that support -Module-set scope only options +Module-set and global scope options @@ -1313,6 +1224,97 @@ installations. However this only works on build systems that support + +git-repository-base + + +TypeString +Available since1.12.1 + +This option 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 behaving as if it had read: + + +module module1 +repository kde:module1.git +end module + +module module2 +repository kde:module2.git +end module + + +The kde: repository prefix used above is a +shortcut which will be setup by automatically. See the TechBase +https://techbase.kde.org/Development/Git/Configuration#URL_Renaming;>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. + + + + +ignore-modules + + +TypeString +Available since1.16 + +Currently can only be used in module-set, see
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Add --dependency-tree-fullpath option
Git commit 74be34cc1b3b4c4a259bc25fb4e69407bc97309c by Andrew Shark. Committed on 28/12/2023 at 09:43. Pushed by ashark into branch 'docbook_historied_per_file'. Add --dependency-tree-fullpath option This option will do similar thing as --dependency-tree, but will print the full path on the line of each tree entry. This may be convenient when you want to grep something from the printed tree, but want to still be able to see the paths. Original commit: 42483187 https://invent.kde.org/sdk/kdesrc-build/-/commit/42483187d75c2787f6c627d6ed1f84e0529a9b6f M +11 -0doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/74be34cc1b3b4c4a259bc25fb4e69407bc97309c diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 5818d7a6..c44823ad 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -587,6 +587,17 @@ If this file doesn't exist, ~/.config/kdesrc-buildrc + +--dependency-tree-fullpath + + +Prints out dependency information on the modules that would be built using a tree +format (recursive). In fullpath format. Note: the generated +output may become quite large for applications with many dependencies. + + + + --run
[sdk/kdesrc-build/docbook_historied_per_file] doc: Fix kdedir default path typo
Git commit d8d16059d14ddf3329810abeffd41822dd9a6ad5 by Nate Graham, on behalf of Andrew Shark. Committed on 27/11/2023 at 15:31. Pushed by ashark into branch 'docbook_historied_per_file'. Fix kdedir default path typo This was intended to be ~/kde/usr. Original commit: 30086010 https://invent.kde.org/sdk/kdesrc-build/-/commit/30086010b7b66f59b8e002617012202882b4b5d3 M +2-2doc/appendix-profile/old-profile-setup.docbook M +1-1doc/getting-started/configure-data.docbook M +1-1doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/d8d16059d14ddf3329810abeffd41822dd9a6ad5 diff --git a/doc/appendix-profile/old-profile-setup.docbook b/doc/appendix-profile/old-profile-setup.docbook index 94d27624..59de9fd5 100644 --- a/doc/appendix-profile/old-profile-setup.docbook +++ b/doc/appendix-profile/old-profile-setup.docbook @@ -26,7 +26,7 @@ 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/src by default. +KDEDIR=(path to kdedir) # Such as ~/kde/usr by default. KDEDIRS=$KDEDIR PATH=$KDEDIR/bin:$QTDIR/bin:$PATH MANPATH=$QTDIR/doc/man:$MANPATH @@ -45,7 +45,7 @@ or, if you are not building qt (and are using your system instead), add this instead: -KDEDIR=(path to kdedir) # Such as ~/kde/src by default. +KDEDIR=(path to kdedir) # Such as ~/kde/usr by default. KDEDIRS=$KDEDIR PATH=$KDEDIR/bin:$QTDIR/bin:$PATH diff --git a/doc/getting-started/configure-data.docbook b/doc/getting-started/configure-data.docbook index 6b2e3371..59021d25 100644 --- a/doc/getting-started/configure-data.docbook +++ b/doc/getting-started/configure-data.docbook @@ -30,7 +30,7 @@ The default settings should be appropriate to perform a kdedir, which changes the destination directory that your software is installed to. This defaults to -~/kde/src, which is a single-user +~/kde/usr, which is a single-user installation. branch-group, which can diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index b6488654..df4ff911 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -766,7 +766,7 @@ flag. kdedir Module setting overrides global This option sets the directory that will be installed to after it -is built. It defaults to ~/kde/src. If you +is built. It defaults to ~/kde/usr. If you change this to a directory needing root access, you may want to read about the make-install-prefix option as well.
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Remove unused option kde-languages
Git commit 88753fbe303969744cc4f158fe6f83b6b896047c by Andrew Shark. Committed on 16/11/2023 at 14:03. Pushed by ashark into branch 'docbook_historied_per_file'. Remove unused option kde-languages Original commit: aec5f8b9 https://invent.kde.org/sdk/kdesrc-build/-/commit/aec5f8b9c19bed58a633f9fb2c72392c0a70cf68 M +0-24 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/88753fbe303969744cc4f158fe6f83b6b896047c diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 42599f39..7831bf87 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -743,30 +743,6 @@ change this to a directory needing root access, you may want to read about the well. - -kde-languages -Cannot be overridden -This option allows you to choose to download and install -localization packages along with . You might do this if you do not live in -the United States and would like to use translated into your native -language. - -To use this option, set it to a space-separated list of languages to -install. Each language has a language code associated with it, which you -can look up at this page: http://l10n.kde.org/teams-list.php;>http://l10n.kde.org/teams-list.php. - - -It is alright to choose only one language. By default, none are -downloaded, which means will display in American English. - -For instance, to choose to install French, you would set the option to -something like: kde-languages -fr. You would still need to use - in order to choose the French language, however. - - - libname Module setting overrides global
[sdk/kdesrc-build/docbook_historied_per_file] doc: Remove unused svn vcs
Git commit f9eb2cb4f0c988eb43331554c54a449703c58176 by Nate Graham, on behalf
of Andrew Shark.
Committed on 09/11/2023 at 16:51.
Pushed by ashark into branch 'docbook_historied_per_file'.
Remove unused svn vcs
We have every module in git now
Original commit: 4be60be8
https://invent.kde.org/sdk/kdesrc-build/-/commit/4be60be81152d46ac311759e5b5bff289085a324
M +2-2doc/appendix-modules/module-concept.docbook
M +3-3doc/appendix-profile/old-profile-setup.docbook
M +6-10 doc/cmdline/supported-cmdline-params.docbook
M +5-13 doc/features/features-overview.docbook
M +3-3doc/features/kdesrc-build-logging.docbook
M +1-8doc/index.docbook
M +1-2doc/introduction/brief-intro.docbook
M +15 -35 doc/kdesrc-buildrc/conf-options-table.docbook
M +4-4doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
M +6-12 doc/using-kdesrc-build/advanced-features.docbook
M +1-1doc/using-kdesrc-build/basic-features.docbook
M +1-3doc/using-kdesrc-build/developer-features.docbook
M +1-7doc/using-kdesrc-build/other-features.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/f9eb2cb4f0c988eb43331554c54a449703c58176
diff --git a/doc/appendix-modules/module-concept.docbook
b/doc/appendix-modules/module-concept.docbook
index ea35e721..b6698592 100644
--- a/doc/appendix-modules/module-concept.docbook
+++ b/doc/appendix-modules/module-concept.docbook
@@ -17,7 +17,7 @@ tested, and installed.
Individual modules
It is easy to set to build a single module. The following
-listing is an example of what a declaration for a Subversion-based module would
+listing is an example of what a declaration for a Git-based module would
look like in the configuration
file.
@@ -27,7 +27,7 @@ module kdefoo
end module
-This is a Subversion-based module since it doesn't use a This is a Git-based module since it doesn't use a repository option. Also, the
cmake-options option is listed as an example only, it is not
required.
diff --git a/doc/appendix-profile/old-profile-setup.docbook
b/doc/appendix-profile/old-profile-setup.docbook
index e0781b2a..24bb86bc 100644
--- a/doc/appendix-profile/old-profile-setup.docbook
+++ b/doc/appendix-profile/old-profile-setup.docbook
@@ -65,10 +65,10 @@ 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"
+export KDEHOME="${HOME}/.kde-git"
# Create it if needed
-[ ! -e ~/.kde-svn ] mkdir ~/.kde-svn
+[ ! -e ~/.kde-git ] mkdir ~/.kde-git
@@ -145,7 +145,7 @@ You can run the from sources and the old at the
same time! Log in
using your regular user, start the stable desktop. Press F2 (or
F1, F3, etc..), and you will be presented
-with a text terminal. Log in using the dedicated user and
+with a text terminal. Log in using the dedicated user and
type:
diff --git a/doc/cmdline/supported-cmdline-params.docbook
b/doc/cmdline/supported-cmdline-params.docbook
index 6d5e4c00..9a08a401 100644
--- a/doc/cmdline/supported-cmdline-params.docbook
+++ b/doc/cmdline/supported-cmdline-params.docbook
@@ -148,10 +148,9 @@ Be very descriptive about what is going on, and what
is doing.
---src-only (or --svn-only
or -s)
+--src-only (or -s)
-Only perform the source update. (The --svn-only is
-only supported for compatibility with older scripts).
+Only perform the source update.
@@ -227,11 +226,9 @@ a few).
---no-src (or --no-svn or
-S)
+--no-src (or -S)
-Skip contacting the server. (The --no-svn
-parameter is only supported for compatibility with older versions of the
-script).
+Skip contacting the server.
@@ -607,7 +604,7 @@ may still be required.
--revision
This option causes to checkout a specific numbered revision
-for each module, overriding any branch,
+for each module, overriding any branch,
tag, or revision
options already set for these modules.
@@ -661,8 +658,7 @@ contain user data, so that the module can be re-downloaded.
This would normally
only be useful for developers (who might have local changes that would be
deleted).
-This is currently only used to checkout modules that have been converted
-from to . You should not use this option normally,
+You should not use this option normally,
will prompt to be re-run with it if it is needed.
diff --git a/doc/features/features-overview.docbook
b/doc/features/features-overview.docbook
index 57f5982b..937f2941 100644
--- a/doc/features/features-overview.docbook
+++ b/doc/features/features-overview.docbook
@@ -24,11 +24,9 @@ doing, try using the --debug option.
- can (with the assistance of the 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 will download the snapshot and
-prepare it for use on your computer.
+ allows you to checkout modules quickly. If the module you are
checking out
[sdk/kdesrc-build/docbook_historied_per_file] doc: Move xsession.sh and kde-env-master.sh templates to data
Git commit 4a025b73f8a83f57b5c484e10d03116b43829265 by Andrew Shark. Committed on 12/12/2023 at 10:04. Pushed by ashark into branch 'docbook_historied_per_file'. Move xsession.sh and kde-env-master.sh templates to data Original commit: beffd6a8 https://invent.kde.org/sdk/kdesrc-build/-/commit/beffd6a8d7250ffab6307bf1492c6ef751bbd3bb M +1-1doc/appendix-profile/old-profile-setup.docbook M +1-1doc/getting-started/environment.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/4a025b73f8a83f57b5c484e10d03116b43829265 diff --git a/doc/appendix-profile/old-profile-setup.docbook b/doc/appendix-profile/old-profile-setup.docbook index 59de9fd5..1aa44da4 100644 --- a/doc/appendix-profile/old-profile-setup.docbook +++ b/doc/appendix-profile/old-profile-setup.docbook @@ -7,7 +7,7 @@ will normally try to do this automatically (see ). This appendix section can be useful for those who cannot use '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 +kde-env-master.sh.in file included with the source. diff --git a/doc/getting-started/environment.docbook b/doc/getting-started/environment.docbook index bf606dd6..d5929b59 100644 --- a/doc/getting-started/environment.docbook +++ b/doc/getting-started/environment.docbook @@ -119,7 +119,7 @@ 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 +appendix or view the kde-env-master.sh.in file included with the source.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Delete the kdesrc-build-setup
Git commit 1967eb5ebe5b757e2e20e140e49d32a31f34d63e by Nate Graham, on behalf of Andrew Shark. Committed on 29/11/2023 at 16:32. Pushed by ashark into branch 'docbook_historied_per_file'. Delete the kdesrc-build-setup This is duplicating the work of --generate-config. But it is mostly broken and creates redundant source of "options defaults", see #132 Can I be made the maintainer of this project? Original commit: 036f5092 https://invent.kde.org/sdk/kdesrc-build/-/commit/036f5092adc382e3cc0e4c5a4946b1dbcb10ec03 M +2-9doc/getting-started/before-building.docbook M +2-4doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/1967eb5ebe5b757e2e20e140e49d32a31f34d63e diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook index b4853081..3e6a70fd 100644 --- a/doc/getting-started/before-building.docbook +++ b/doc/getting-started/before-building.docbook @@ -157,16 +157,11 @@ This file is located at ~/.config/kdesrc-buildrc ($XDG_CONFIG_HOME/kdesrc-buildrc, if $XDG_CONFIG_HOME is set). -You can use a program included with , called -kdesrc-build-setup in order to prepare a simple +You can use kdesrc-build --generate-config in order to prepare a simple kdesrc-build configuration. You can then edit the ~/.config/kdesrc-buildrc configuration file to make any changes you see fit. -kdesrc-build-setup itself runs from a terminal -(instead of using a graphical interface), just like , so you can -use it even if you have no graphical interface available yet. - Manual setup of configuration file @@ -178,9 +173,7 @@ its table of configuration options. contains many recommended configuration files to support - Frameworks 5, 5, and other applications. The -kdesrc-build-setup refers to these files in the -configuration file it generates, but you can also use them yourself. See + Frameworks 5, 5, and other applications. See for information on how to use other configuration files from your own kdesrc-buildrc. diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 5545dc53..038b25e0 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -280,8 +280,7 @@ number, the "nicer" the program is. Default valueDepends on system Available since20.07 -This option is defined by (when using the kdesrc-build-setup tool -or kdesrc-build --generate-config), set to be the number of +This option is defined by (when using kdesrc-build --generate-config), set to be the number of available CPUs (as indicated by the external application nproc). If cannot detect the number of CPUs, this value is set to 4. @@ -299,8 +298,7 @@ option's usage. Default valueDepends on system Available since20.07 -This option is defined by (when using the kdesrc-build-setup tool -or kdesrc-build --generate-config), set to be the number of +This option is defined by (when using kdesrc-build --generate-config), set to be the number of CPUs that is deemed safe for heavyweight or other highly-intensive modules, such as qtwebengine, to avoid running out of memory during the build.
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Comply documentation for stop-on-failure conf option
Git commit bd82b2f32eff7e4f53b1c45d81c89866164ee178 by Nate Graham, on behalf of Andrew Shark. Committed on 11/09/2023 at 16:51. Pushed by ashark into branch 'docbook_historied_per_file'. Comply documentation for stop-on-failure conf option The [doc](https://docs.kde.org/trunk5/en/kdesrc-build/kdesrc-build/conf-options-table.html#conf-stop-on-failure) says it is off by default. CCBUG: 474263 Original commit: a49e8272 https://invent.kde.org/sdk/kdesrc-build/-/commit/a49e8272602fb85474a352d4d4fa363711aaa70b M +1-2doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/bd82b2f32eff7e4f53b1c45d81c89866164ee178 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 7c57fb95..51780025 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -1192,8 +1192,7 @@ linkend="ssh-agent-reminder"/>. 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. +after an error occurs during the build or install process. This option is true by default.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Remove unused opts from doc
Git commit dc1db91d69e2c65285c87c22c850e0f9be933667 by Nate Graham, on behalf of Andrew Shark. Committed on 17/11/2023 at 16:18. Pushed by ashark into branch 'docbook_historied_per_file'. Remove unused opts from doc Original commit: 176f459a https://invent.kde.org/sdk/kdesrc-build/-/commit/176f459a855b747730163813ed05e0a4e6f9 M +0-10 doc/cmdline/supported-cmdline-params.docbook M +0-2doc/index.docbook M +0-109 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/dc1db91d69e2c65285c87c22c850e0f9be933667 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 9a08a401..71cefc69 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -346,16 +346,6 @@ kdepim: master - ---no-rebuild-on-fail - -Do not try to -rebuild modules that have failed building from scratch. will -never try to do this to a module that already was tried to be built from -scratch. - - - --refresh-build (or -r) diff --git a/doc/index.docbook b/doc/index.docbook index 62dd863d..6d3d6b5a 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -44,8 +44,6 @@ module-base-path'> override-url'> source-dir'> - email-address'> - email-on-compile-error'> colorful-output'> tag'> branch'> diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 7831bf87..44a1c6b0 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -32,27 +32,6 @@ option. - -apidox - -This option was used to allow for building KDE module API documentation. -It was removed in 1.6.3 due to lack of support. Online -API documentation is available from https://api.kde.org/;>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 https://techbase.kde.org/Development/Tools/apidox;>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 @@ -120,23 +99,6 @@ option. 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 - 4-based libraries and applications. - -latest-qt4, for tracking development and new -features for the 4-based libraries and -applications. - -kf5-qt5, for tracking -bleeding-edge development for the upcoming 5-based -Frameworks 5, Workspace 2, - - - 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 - -email-address -Cannot be overridden - -This option was removed in 1.14. - - - - - -email-on-compile-error -Cannot be overridden - -This option was removed in 1.14. - - - - - -inst-apps - - -This option was removed in version 1.10 - - - git-desired-protocol Cannot be overridden @@ -574,17 +510,6 @@ on also use that proxy server, if possible, by setting the - -ignore-kde-structure -Module setting overrides global - -This option is deprecated and will be removed (again) in a future release. - -Please use directory-layout -instead, which offers more options. - - - directory-layout Module setting overrides global @@ -889,13 +814,6 @@ 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. - - num-cores Cannot be overridden @@ -1194,14 +1112,6 @@ until 1.16. - -use-cmake - -This option was removed in 1.4 as all 4 modules -require , and use is not permitted on any other modules. - - - use-idle-io-priority Cannot be overridden @@ -1259,25 +1169,6 @@ of its use and an example. - -use-qt-builddir-hack -Module setting overrides global -This option has been removed due to improvements in the 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 branch-group -instead, which offers more selectivity. - - -
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Support invoking initial setup steps separately
Git commit e615a6cbef8e81b5d37c7f0a374542d19dac526b by Thiago Sueto, on behalf of Andrew Shark. Committed on 23/11/2023 at 15:57. Pushed by ashark into branch 'docbook_historied_per_file'. Support invoking initial setup steps separately Related to https://invent.kde.org/sdk/kdesrc-build/-/issues/132 Original commit: 7e1ceafd https://invent.kde.org/sdk/kdesrc-build/-/commit/7e1ceafd61b754fc55186d95fd4e241482c10361 M +32 -1doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/e615a6cbef8e81b5d37c7f0a374542d19dac526b diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 79fe89cc..db549d02 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -54,8 +54,39 @@ software to run. Adding required environment variables to ~/.bashrc Setting up a configuration file +This option is exactly equivalent to using +--install-distro-packages +--generate-config +--update-shellrc at the same time. + + + -Available since version 18.11. + +--install-distro-packages + +Installs distro packages (on supported distributions) necessary to prepare the system for to operate, and for the newly-installed +software to run. + +See also --initial-setup + + + + +--generate-config + +Generate the configuration file. + +See also --initial-setup + + + + +--update-shellrc + +Edit the "~/.bashrc" (or other shell rc file) to add to your $PATH variable and enable autocompletion. + +See also --initial-setup
[sdk/kdesrc-build/docbook_historied_per_file] doc: Fix minor typo
Git commit e8caa045139cd576f7b0c9b63b2ad1bbeee83b63 by Yuri Chornoivan. Committed on 13/11/2023 at 16:00. Pushed by ashark into branch 'docbook_historied_per_file'. Fix minor typo Original commit: 883f068e https://invent.kde.org/sdk/kdesrc-build/-/commit/883f068eabace140d44e3bd9b68d415fc1c4f80d M +2-2doc/appendix-profile/old-profile-setup.docbook M +1-1doc/getting-started/environment.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/e8caa045139cd576f7b0c9b63b2ad1bbeee83b63 diff --git a/doc/appendix-profile/old-profile-setup.docbook b/doc/appendix-profile/old-profile-setup.docbook index 925f7cb0..b1210648 100644 --- a/doc/appendix-profile/old-profile-setup.docbook +++ b/doc/appendix-profile/old-profile-setup.docbook @@ -109,7 +109,7 @@ create it if necessary. Add the line: 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 -ssdm, gdm, or xdm. +sddm, gdm, or xdm. @@ -122,7 +122,7 @@ 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 environment, even if it is not listed -as an option. Most display managers, including ssdm, have an option to use +as an option. Most display managers, including sddm, 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 diff --git a/doc/getting-started/environment.docbook b/doc/getting-started/environment.docbook index 47112ade..bf606dd6 100644 --- a/doc/getting-started/environment.docbook +++ b/doc/getting-started/environment.docbook @@ -22,7 +22,7 @@ configuration file option. in pretend mode. This driver works by setting up a custom xsession -session type. This type of session should work by default with the ssdm login +session type. This type of session should work by default with the sddm login manager (where it appears as a Custom session), but other login managers (such as LightDM and gdm) may require additional files installed to
[sdk/kdesrc-build/docbook_historied_per_file] doc: buildsystem: Complete removal of checkout-only support, incl l10n.
Git commit 9f60c906029de2402922807ac4ca322a56875159 by Michael Pyne. Committed on 17/01/2022 at 00:33. Pushed by ashark into branch 'docbook_historied_per_file'. buildsystem: Complete removal of checkout-only support, incl l10n. l10n support (for kde-languages) hasn't worked for the entire KF5 era. Subversion is still available for those using it, kdesrc-build just won't try to do automagic here anymore. Original commit: 7406a96f https://invent.kde.org/sdk/kdesrc-build/-/commit/7406a96f53177ee4a084a3f02f043982f182e923 M +3-5doc/cmdline/supported-cmdline-params.docbook M +13 -17 doc/getting-started/before-building.docbook M +7-10 doc/getting-started/configure-data.docbook M +15 -26 doc/kdesrc-buildrc/conf-options-table.docbook M +7-57 doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/9f60c906029de2402922807ac4ca322a56875159 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 75c2c452..25c4f8cc 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -496,11 +496,9 @@ This option was added with 1.16. See also the 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 working directory). -If this file doesn't exist, ~/.config/kdesrc-buildrc -($XDG_CONFIG_HOME/kdesrc-buildrc, if -$XDG_CONFIG_HOME is set) will be used instead. See also -. +kdesrc-buildrc (checked in the current directory) if +it is present, or ~/.kdesrc-buildrc otherwise. See +also . diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook index b4853081..d6920929 100644 --- a/doc/getting-started/before-building.docbook +++ b/doc/getting-started/before-building.docbook @@ -151,17 +151,15 @@ without having to fully specify its path every time. Prepare the configuration file - uses a configuration file -to control which modules are built, where they are installed to, etc. -This file is located at ~/.config/kdesrc-buildrc -($XDG_CONFIG_HOME/kdesrc-buildrc, if -$XDG_CONFIG_HOME is set). + 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 , called kdesrc-build-setup in order to prepare a simple kdesrc-build configuration. You can then edit the -~/.config/kdesrc-buildrc configuration file to make -any changes you see fit. +~/.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 , so you can @@ -171,19 +169,17 @@ 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 ~/.config/kdesrc-buildrc and then editing the file. - will be a useful reference for this, especially -its table of configuration options. +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. contains many recommended configuration files to support - Frameworks 5, 5, and other 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. - + Frameworks 5, 5, and other 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 Setting the Configuration Data -To use , you should have a file in your ~/.config -(or in $XDG_CONFIG_HOME, if set) directory called -kdesrc-buildrc, which sets the general options and -specifies the modules you would like to download and build. +To use , 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 , which is -described in . If you need to use multiple -configurations, please see that section. Here, we will assume that the -configuration is stored in ~/.config/kdesrc-buildrc. - +It is possible to use different configuration files for , +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
[sdk/kdesrc-build/docbook_historied_per_file] doc: Merge remote-tracking branch 'verahawk/xdg_spec'
Git commit 0b70fc7f85f802eed164e434ee3db39db546c37d by Michael Pyne. Committed on 22/01/2022 at 23:35. Pushed by ashark into branch 'docbook_historied_per_file'. Merge remote-tracking branch 'verahawk/xdg_spec' Implements MR !122 Conflicts: kdesrc-build Original commit: 989cf8e9 https://invent.kde.org/sdk/kdesrc-build/-/commit/989cf8e9f56c38ebbc01dae14cae6482285ae774 M +9-16 doc/kdesrc-buildrc/conf-options-table.docbook M +7-57 doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/0b70fc7f85f802eed164e434ee3db39db546c37d diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 379cfa80..5c07eb25 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -214,16 +214,9 @@ change at all. checkout-only Module setting overrides global -Set this option to checkout sources piece by piece. The -value for this option should be a space-separated list of directories to -checkout. Although this option overrides the global option, be aware that -setting this as a global option makes no sense. - - -Note that this setting has no effect on modules due to the -operation of the source control system. - -See for an example. +This option was removed in January 2022. It used to control +the ability to checkout subsets of a module from a Subversion repository. + @@ -412,13 +405,13 @@ for every module. You can disable this check by setting Use this option to select a specific set of directories not to be built in a module (instead of all of them). The directories not to build should be space-separated. -Note that the sources to the programs will still be downloaded. You can use -the checkout-only -directive to choose directories that you want to check out. +Note that the sources to the programs will still be downloaded. -For example, to hold and in the kdemultimedia module from -compiling, you would add "do-not-compile juk kscd" to your kdemultimedia -settings. +For example, to disable building the codeeditor and minimaltest +directories of the syntaxhighlighting framework, you +would add do-not-compile codeeditor minimaltest +compiling, you would add "do-not-compile juk kscd" to your syntaxhighlighting +options. See for an example. diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index 45e73a44..6c41cc2e 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -9,69 +9,19 @@ has features to make this easy. There are several complementing ways to do this. - -Checking out portions of a module - -This is perhaps the best way to do this. When it works, it will save you -download time and disk space. What happens is that will download -only the parts of a module that you specify. This is done using the -option for a module, which will specify a list of directories to download. - - - -If you do not already know what to download from a module, it may be a good idea -to browse the layout for a module first, using -https://websvn.kde.org/branches/KDE/4.6/;>WebSVN. - - - -To only grab and KSystemLog from -kdeadmin, you could use like this: - - -module kdeadmin - kuser ksystemlog -end module - - - - -The directories will be built in the order they are listed -in the option. If one of the directories needs something else from the module -to compile, then you need to make sure they are both in the -line, and that the required dependency goes before the directory that needs it. - -Also, sometimes an application may need other directories and it is hard -to figure out what they are, which may require some trial and error of constantly -adding directories to the option to figure out. This option depends on support -from the build system of the module, so it is only useful for modules that are -collections of individual applications. - - -One final note to make about this option: If you change the value of this -option, you should use kdesrc-build - module -in order to ensure that the module is reconfigured properly. In addition, - will never remove existing files if you take away the number of -directories from your option, or add the option to a module that -has already been checked out. - - - Removing directories from a build -Instead of restricting what is downloaded, it is possible to download -everything but have the build system leave out a few directories when it does -the build. This may be useful if one directory always breaks and is -unnecessary to the rest of the module. +It is possible to download an entire repository +but have the build system leave out a few directories when it does +the build. This requires that the module uses and that the +module's build system allows the directory to remove to be +optional. -This is controlled with the option. It
[sdk/kdesrc-build/docbook_historied_per_file] doc/introduction: doc/index.docbook correct website for subversion
Git commit 776e516911956494f81342de1e23a1881329ba1a by Nate Graham, on behalf of Marius P. Committed on 21/11/2022 at 20:30. Pushed by ashark into branch 'docbook_historied_per_file'. doc/index.docbook correct website for subversion "http://subversion.tigris.org/; -> "https://subversion.apache.org;. Original commit: 99c49336 https://invent.kde.org/sdk/kdesrc-build/-/commit/99c49336d9c8044646679299a64c8339b7863502 M +1-1doc/introduction/brief-intro.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/776e516911956494f81342de1e23a1881329ba1a diff --git a/doc/introduction/brief-intro.docbook b/doc/introduction/brief-intro.docbook index f7371b62..aa5bed9e 100644 --- a/doc/introduction/brief-intro.docbook +++ b/doc/introduction/brief-intro.docbook @@ -8,7 +8,7 @@ is a script to help the community install https://www.kde.org/;> software from its https://git-scm.com/;> and http://subversion.tigris.org/;> source repositories, +url="https://subversion.apache.org;> source repositories, and continue to update that software afterwards. It is particularly intended to support those who need to supporting testing and development of software, including users testing bugfixes and developers
[sdk/kdesrc-build/docbook_historied_per_file] doc/cmdline: Add short options for --[no-]include-dependencies.
Git commit 5c8758a40dd9c47b73c22f77be71f09a2051d3bf by Michael Pyne. Committed on 07/09/2023 at 00:34. Pushed by ashark into branch 'docbook_historied_per_file'. Add short options for --[no-]include-dependencies. This adds and documents -d as a short alias for --include-dependencies, and a corresponding -D as its negation. While I'm at it, and at user request, this also adds short options for: * --help * --no-src * --src-only * --refresh-build * --ignore-modules * --resume-from and --resume-after BUG:473859 Original commit: 5b155c5e https://invent.kde.org/sdk/kdesrc-build/-/commit/5b155c5e29dd2d377fd1f84fb42d0e629a9f368b M +11 -11 doc/cmdline/supported-cmdline-params.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/5c8758a40dd9c47b73c22f77be71f09a2051d3bf diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 75c2c452..6d5e4c00 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -18,7 +18,7 @@ configuration. ---help +--help (or -h) Only display simple help on this script. @@ -148,7 +148,7 @@ Be very descriptive about what is going on, and what is doing. ---src-only (or --svn-only) +--src-only (or --svn-only or -s) Only perform the source update. (The --svn-only is only supported for compatibility with older scripts). @@ -197,8 +197,8 @@ work. ---include-dependencies ---no-include-dependencies +--include-dependencies (or -d) +--no-include-dependencies (or -D) This option causes to automatically include other and modules in the build, if required for the modules you have requested to build @@ -217,7 +217,7 @@ automatic inclusion of additional dependency modules. ---ignore-modules +--ignore-modules (or -!) 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 @@ -227,7 +227,7 @@ a few). ---no-src (or --no-svn) +--no-src (or --no-svn or -S) Skip contacting the server. (The --no-svn parameter is only supported for compatibility with older versions of the @@ -360,7 +360,7 @@ scratch. ---refresh-build +--refresh-build (or -r) Recreate the build system and make from scratch. @@ -379,7 +379,7 @@ linkend="cmdline-refresh-build">--refresh-build is used. ---resume-from +--resume-from (or --from or -f) 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 @@ -400,7 +400,7 @@ build. ---resume-after +--resume-after (or --after or -a) 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 @@ -449,7 +449,7 @@ This option was added with 1.16. ---stop-before +--stop-before (or --until) This command line option is used to stop the normal build process just before a module would ordinarily be built. @@ -464,7 +464,7 @@ This command line option was added with 1.16. ---stop-after +--stop-after (or --to) This command line option is used to stop the normal build process just after a module would ordinarily be built.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Indicate the existence of --no-stop-on-failure flag
Git commit 1860f30bf92298ead7d355c29ca5e91135d7a0e5 by Joshua Goins, on behalf of Andrew Shark. Committed on 20/11/2023 at 16:03. Pushed by ashark into branch 'docbook_historied_per_file'. Indicate the existence of --no-stop-on-failure flag BUG: 474263 Original commit: c300de55 https://invent.kde.org/sdk/kdesrc-build/-/commit/c300de55cd6b4519192ab79800d8cf78e0d98bb1 M +4-10 doc/cmdline/supported-cmdline-params.docbook M +2-2doc/getting-started/building-and-troubleshooting.docbook M +2-2doc/kdesrc-buildrc/conf-options-table.docbook M +3-3doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/1860f30bf92298ead7d355c29ca5e91135d7a0e5 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 71cefc69..79fe89cc 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -423,12 +423,6 @@ building the modules you were building before, without fiddling with --resume-from and --stop-before. - -This is even handier with the --stop-on-failure command -line argument, especially if you're initially setting up your development -environment. - This option was added with 1.16. @@ -467,14 +461,14 @@ This command line option was added with 1.16. --stop-on-failure +--no-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, - will try to press on with the rest of the modules in the build +This option controls if the build will be aborted as soon as a failure occurs. +Default behavior is --stop-on-failure. You may override it if you wish 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 1.16. See also the -stop-on-failure option. +stop-on-failure configuration file option. diff --git a/doc/getting-started/building-and-troubleshooting.docbook b/doc/getting-started/building-and-troubleshooting.docbook index 95e3c6db..b9d478eb 100644 --- a/doc/getting-started/building-and-troubleshooting.docbook +++ b/doc/getting-started/building-and-troubleshooting.docbook @@ -39,10 +39,10 @@ linkend="cmdline-pretend">--pretend command line option. to actually running the script. - kdesrc-build --stop-on-failure + 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 --stop-on-failure option). Afterwards, you should see output similar to that in This command will download the appropriate source code, build and install each module in order. Afterwards, you should see output similar to that in : diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 44a1c6b0..cf046afb 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -1076,8 +1076,8 @@ linkend="ssh-agent-reminder"/>. 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 true by default. +Setting this option to false allows the script to continue execution +after an error occurs during the build or install process. Default value is true. diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index f6e56fee..3d9e89c0 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -193,11 +193,11 @@ successfully built the modules in the list. -Stopping early with --stop-on-failure +Not stopping early with --no-stop-on-failure The primary method to do this is to use the ---stop-on-failure +--no-stop-on-failure command line option when you run . @@ -226,7 +226,7 @@ installing a module. -Stopping early without --stop-on-failure +Stopping gracefully when stop-on-failure is false As mentioned above, it is possible to cause to gracefully shutdown early once it has completed the module it is currently working on.
[sdk/kdesrc-build/docbook_historied_per_file] doc: Allow to build/install doc in kf6 too
Git commit 649621237a42d25f18ba2bd3881a1bb2d7a8c7d2 by Laurent Montel. Committed on 12/11/2023 at 17:56. Pushed by ashark into branch 'docbook_historied_per_file'. Allow to build/install doc in kf6 too Original commit: 5a0754e7 https://invent.kde.org/sdk/kdesrc-build/-/commit/5a0754e7c34ab20d6555f9759921c6b6a9e136c2 M +2-2doc/appendix-profile/old-profile-setup.docbook M +1-1doc/getting-started/environment.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/649621237a42d25f18ba2bd3881a1bb2d7a8c7d2 diff --git a/doc/appendix-profile/old-profile-setup.docbook b/doc/appendix-profile/old-profile-setup.docbook index 24bb86bc..925f7cb0 100644 --- a/doc/appendix-profile/old-profile-setup.docbook +++ b/doc/appendix-profile/old-profile-setup.docbook @@ -109,7 +109,7 @@ create it if necessary. Add the line: 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 -, gdm, or xdm. +ssdm, gdm, or xdm. @@ -122,7 +122,7 @@ 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 environment, even if it is not listed -as an option. Most display managers, including , have an option to use +as an option. Most display managers, including ssdm, 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 diff --git a/doc/getting-started/environment.docbook b/doc/getting-started/environment.docbook index 6d93a5ce..47112ade 100644 --- a/doc/getting-started/environment.docbook +++ b/doc/getting-started/environment.docbook @@ -22,7 +22,7 @@ configuration file option. in pretend mode. This driver works by setting up a custom xsession -session type. This type of session should work by default with the login +session type. This type of session should work by default with the ssdm login manager (where it appears as a Custom session), but other login managers (such as LightDM and gdm) may require additional files installed to
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Correct default directory-layout value in documentation.
Git commit 66b1f6258f0483c4e5b3fa1b51e4866a053c0268 by Nate Graham. Committed on 02/11/2022 at 18:15. Pushed by ashark into branch 'docbook_historied_per_file'. Correct default directory-layout value in documentation. It's "Flat" now, and has been for a while. BUG: 461279 Original commit: 7fe7c940 https://invent.kde.org/sdk/kdesrc-build/-/commit/7fe7c940833018f578c006fb3159aa1f6f0ba42a M +4-6doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/66b1f6258f0483c4e5b3fa1b51e4866a053c0268 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 5c07eb25..331fefee 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -599,10 +599,10 @@ instead, which offers more options. Module setting overrides global This option is used to configure the layout which should use when creating source and build directories. -Currently, there are three possible values: metadata, -invent and flat -The flat layout will group all modules directly underneath the top level -source and build directories. For example, +Currently, there are three possible values: flat, +invent, and metadata. +The flat layout is the default value, and will group all modules +directly underneath the top level source and build directories. For example, source/extragear/network/telepathy/ktp-text-ui in the metadata layout would be source/ktp-text-ui using the flat layout instead. @@ -620,8 +620,6 @@ project metadata for these modules. This is a good choice if you want a director tracks with certain KDE processes, but note that this path is therefore not always stable. As a result, may abandon an old copy of the repository and clone a new one for a project due to changes in the project metadata. -By default the metadata layout will be used, to preserve backwards -compatibility for existing users of .
[sdk/kdesrc-build/docbook_historied_per_file] doc: Set rpath to kdedir for appstream, which uses meson
Git commit 18d054554a08282d78a1f20fad4ee8216095941c by Nate Graham, on behalf of Jakob Petsovits. Committed on 02/06/2023 at 15:51. Pushed by ashark into branch 'docbook_historied_per_file'. Set rpath to kdedir for appstream, which uses meson Without this, appstreamcli and libAppStreamQt.so (used all over Plasma, including Discover) would rely on LD_LIBRARY_PATH to find the correct libappstream.so. That's not great because the standard prefix.sh doesn't set LD_LIBRARY_PATH, relying on rpath instead. Appstream's meson build doesn't set rpath for installed binaries by default, but can be prodded into adding it with LDFLAGS. In order to provide the correct name of the library directory to kdesrc-build, e.g. "lib" or "lib64", this commit introduces a new option called libname. Its default value gets initialized in the same way as an earlier shell implementation in sample-kde-env-master.sh, which doesn't appear to be widely used at this point but clearly had some experience going into it. Original commit: f9ec8c08 https://invent.kde.org/sdk/kdesrc-build/-/commit/f9ec8c084989341af6f4c0a579f3f35e042cd7b4 M +1-0doc/index.docbook M +12 -2doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/18d054554a08282d78a1f20fad4ee8216095941c diff --git a/doc/index.docbook b/doc/index.docbook index 73310e92..88a3e33a 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -56,6 +56,7 @@ make-install-prefix'> niceness'> set-env'> + libname'> libpath'> binpath'> diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 331fefee..7c57fb95 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -776,14 +776,24 @@ something like: kde-languages + +libname +Module setting overrides global +Set this option to change the default name of the installed library directory +inside $KDEDIR and $QTDIR. On many systems this is either +"lib" or "lib64". Auto-detection is attempted to set the correct name by default, +but if the guess is wrong then it can be changed with this setting. + + + 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. +class="directory">$KDEDIR/$LIBNAME and $QTDIR/$LIBNAME are automatically added. You may use the tilde (~) for any paths you add using this option.
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Changed docs to mention support for CMake Extra Generators introduced in last commit.
Git commit 9ecc15bd59be2e3ae2d0396933b5c32fa992b04b by Johan Ouwerkerk, on behalf of David Lerch. Committed on 26/01/2021 at 16:11. Pushed by ashark into branch 'docbook_historied_per_file'. Changed docs to mention support for CMake Extra Generators introduced in last commit. Original commit: 8f25eb9e https://invent.kde.org/sdk/kdesrc-build/-/commit/8f25eb9e47b665ffcada54252a35a578a7247739 M +4-2doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/9ecc15bd59be2e3ae2d0396933b5c32fa992b04b diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 7567f440..499ac3e7 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -231,8 +231,10 @@ operation of the source control system. Module setting overrides global Use this option to specify which generator to use with . Currently both Ninja and Unix Makefiles -are supported. Invalid (unsupported) values are ignored and treated as if -unset. If not set Unix Makefiles will be used by default. +as well as extra generators based on them like Eclipse CDT4 - Ninja + are supported. Invalid (unsupported) values are ignored and treated +as if unset. If not set Unix Makefiles will be used by +default. Note that if a valid generator is also specified through
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: rc-file: Add "num-cores-low-mem" and move num-cores* defs to initial-setup.
Git commit 03d5ed404767a82a00ee92184d09104f4fa179e1 by Michael Pyne. Committed on 12/07/2020 at 00:08. Pushed by ashark into branch 'docbook_historied_per_file'. rc-file: Add "num-cores-low-mem" and move num-cores* defs to initial-setup. It is annoying to be maintaining kdesrc-build-setup and --initial-setup but combining those two can be a subsequent refactoring. This adds a separate num-cores-low-mem to address the qtwebengine case and makes both num-cores and num-cores-low-mem into an option generated during initial setup, and only used by the default config (rather than any part of the kdesrc-build internals directly). There is a fallback reference in the code in case there is a usage of the default configuration file sections (e.g. qt5-build-include) but this is set conservatively (4 cores, 2 cores during low-mem). At this point it's almost "just" a configuration convention with a bit of code in the setup wizard so perhaps it's best not to touch the rest of the code/docs at all, but I'm happy with where this is at. I've tested --initial-setup in a Docker container (Fedora 29 with perl manually installed first) and tested kdesrc-build-setup separately. Original commit: 654e1392 https://invent.kde.org/sdk/kdesrc-build/-/commit/654e1392a90777c3bb53e156cf26098dc128e3a1 M +27 -1doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/03d5ed404767a82a00ee92184d09104f4fa179e1 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 386f3cf5..699ef4e4 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -880,7 +880,8 @@ due to fixes in the underlying build system. num-cores Cannot be overridden -This option is automatically set by to the number of +This option is defined by (when using the kdesrc-build-setup tool +or kdesrc-build --initial-setup), set to be the number of available CPUs (as indicated by the external application nproc). If cannot detect the number of CPUs, this value is set to 4. @@ -890,6 +891,31 @@ option's usage. This option was added in version 20.07. + +num-cores-low-mem +Cannot be overridden + +This option is defined by (when using the kdesrc-build-setup tool +or kdesrc-build --initial-setup), set to be the number of +CPUs that is deemed safe for heavyweight or other highly-intensive modules, +such as qtwebengine, to avoid running out of memory +during the build. + +The typical calculation is one CPU core for every 2 +gigabytes (GiB) of total memory. At least 1 core will be specified, +and no more than num-cores +cores will be specified. + +Although this option is intended to support modules, you can use it for your +any module in the same way that num-cores is used. + +If cannot detect available memory then this value will be +set to 2. + +This option was added in version 20.07. + + + override-build-system Module setting overrides global
[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: feat: support organising cloned source directories according to the 'layout' of repositories on invent.kde.org
Git commit 74b141e309a6e65f0b35f3c4cda5965b90c626d9 by Johan Ouwerkerk. Committed on 23/12/2020 at 18:01. Pushed by ashark into branch 'docbook_historied_per_file'. feat: support organising cloned source directories according to the 'layout' of repositories on invent.kde.org Issues: #59 Original commit: 6c17bceb https://invent.kde.org/sdk/kdesrc-build/-/commit/6c17bceb1f4e890fa588f0814843a8b8da955027 M +35 -8doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/74b141e309a6e65f0b35f3c4cda5965b90c626d9 diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 699ef4e4..7567f440 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -568,15 +568,42 @@ on also use that proxy server, if possible, by setting the 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 is deprecated and will be removed (again) in a future release. -This option was introduced with 1.16. +Please use directory-layout +instead, which offers more options. + + + + +directory-layout +Module setting overrides global +This option is used to configure the layout which should use when +creating source and build directories. +Currently, there are three possible values: metadata, +invent and flat +The flat layout will group all modules directly underneath the top level +source and build directories. For example, +source/extragear/network/telepathy/ktp-text-ui in the metadata +layout would be source/ktp-text-ui using the flat layout +instead. + +The invent layout creates a directory hierarchy mirroring the relative +paths of repositories on https://invent.kde.org/;>invent.kde.org. For example +source/kde/applications/kate in the metadata layout would +be source/utilities/kate using the invent layout instead. +This layout only affects KDE projects. It is a good choice for people starting out with +. + +Finally, the metadata layout is the same as the old default +behaviour. This layout organises KDE projects according to the project paths specified in the +project metadata for these modules. This is a good choice if you want a directory layout which +tracks with certain KDE processes, but note that this path is therefore not always stable. As a +result, may abandon an old copy of the repository and clone a new one for a project +due to changes in the project metadata. +By default the metadata layout will be used, to preserve backwards +compatibility for existing users of .
[sdk/kdesrc-build/docbook_historied_per_file] doc: rc-file: Update num-cpus to be num-cores, use env vars.
Git commit fe51ee369119ce78b98cd5fd6a1d1070d543e43e by Michael Pyne.
Committed on 08/07/2020 at 03:22.
Pushed by ashark into branch 'docbook_historied_per_file'.
rc-file: Update num-cpus to be num-cores, use env vars.
Original commit: 27505b67
https://invent.kde.org/sdk/kdesrc-build/-/commit/27505b67a2775cdb04c46b438e54b06158d6b658
M +4-2doc/getting-started/configure-data.docbook
M +2-2doc/kdesrc-buildrc/conf-options-table.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/fe51ee369119ce78b98cd5fd6a1d1070d543e43e
diff --git a/doc/getting-started/configure-data.docbook
b/doc/getting-started/configure-data.docbook
index 10f27e82..5643e977 100644
--- a/doc/getting-started/configure-data.docbook
+++ b/doc/getting-started/configure-data.docbook
@@ -65,7 +65,7 @@ compile jobs you wish to allow. A higher number (up to the
number of logical CP
your system has available) leads to quicker builds, but requires more system
resources.
- sets the option num-cpus to
+ sets the option num-cores to
the detected number of available processing cores. You can use this value
in your own configuration file to avoid having to set it manually.
@@ -74,7 +74,9 @@ in your own configuration file to avoid having to set it
manually.
Configuring Make to use all available CPUs, with exceptions
global
-make-options -j ${num-cpus}
+# This environment variable is automatically used by make, including
+# make commands not run by kdesrc-build directly, such as Qt's configure
+set-env MAKEFLAGS -j${num-cores}
end global
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook
b/doc/kdesrc-buildrc/conf-options-table.docbook
index 0abbb9bd..386f3cf5 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -876,8 +876,8 @@ module if it normally would have tried anyways.
due to fixes in the underlying build system.
-
-num-cpus
+
+num-cores
Cannot be overridden
This option is automatically set by to the number of
[sdk/kdesrc-build/docbook_historied_per_file] doc/getting-started: Mention cli option in the filtering section as well.
Git commit eaebc057241731ba2b71560551e896677d2da054 by Adriaan de Groot. Committed on 21/12/2020 at 11:02. Pushed by ashark into branch 'docbook_historied_per_file'. Mention cli option in the filtering section as well. Original commit: a866c8bc https://invent.kde.org/sdk/kdesrc-build/-/commit/a866c8bc7704397e2332831a83aac163f457d78f M +5-1doc/getting-started/kde-modules-and-selection.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/eaebc057241731ba2b71560551e896677d2da054 diff --git a/doc/getting-started/kde-modules-and-selection.docbook b/doc/getting-started/kde-modules-and-selection.docbook index 60c45f15..b064ad16 100644 --- a/doc/getting-started/kde-modules-and-selection.docbook +++ b/doc/getting-started/kde-modules-and-selection.docbook @@ -315,7 +315,11 @@ decide that you'd rather not download, build, and install kdeutils. You can achieve this by using the ignore-modules configuration option. +linkend="conf-ignore-modules">ignore-modules configuration option. +On the command line the + option +does the same thing, but is more convenient for filtering out a module just once. + Example for ignoring a kde-project module in a group
[sdk/kdesrc-build/docbook_historied_per_file] doc: rc-file: Add "num-cpus" option by default and use it in default setup.
Git commit 60be7b8ccf9955046a8ee04a0e9981b41591f473 by Michael Pyne.
Committed on 07/07/2020 at 02:07.
Pushed by ashark into branch 'docbook_historied_per_file'.
rc-file: Add "num-cpus" option by default and use it in default setup.
This change introduces a "num-cpus" option that is inherently present in
the build context.
This permits config file reading code to refer to this option (due to an
existing kdesrc-build feature). So I also update the various available
methods of generating a default configuration to use this option instead
of hardcoding a -j value for make-options (or leaving it blank).
This should provide maximum performance for most users (who aren't using
or can't use the existing Ninja support, anyways), as long as they are
able to start from a generated configuration.
Users with existing configuration files would need to regenerate it or
edit it to add "make-options -j ${num-cpus}" (including separately to
their Qt5 options if applicable, as global options are ignored for
non-KDE modules).
See issue #39.
Original commit: 57e6c0c3
https://invent.kde.org/sdk/kdesrc-build/-/commit/57e6c0c3b9299b136fc20c02846563bea49e3cf4
M +7-2doc/getting-started/configure-data.docbook
M +14 -0doc/kdesrc-buildrc/conf-options-table.docbook
M +19 -0doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
https://invent.kde.org/sdk/kdesrc-build/-/commit/60be7b8ccf9955046a8ee04a0e9981b41591f473
diff --git a/doc/getting-started/configure-data.docbook
b/doc/getting-started/configure-data.docbook
index 50eefc42..10f27e82 100644
--- a/doc/getting-started/configure-data.docbook
+++ b/doc/getting-started/configure-data.docbook
@@ -65,11 +65,16 @@ compile jobs you wish to allow. A higher number (up to the
number of logical CP
your system has available) leads to quicker builds, but requires more system
resources.
+ sets the option num-cpus to
+the detected number of available processing cores. You can use this value
+in your own configuration file to avoid having to set it manually.
+
+
-Configuring Make for 4 compiles at once, with exceptions
+Configuring Make to use all available CPUs, with exceptions
global
-make-options -j4
+make-options -j ${num-cpus}
end global
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook
b/doc/kdesrc-buildrc/conf-options-table.docbook
index 2f4648e0..0abbb9bd 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -876,6 +876,20 @@ module if it normally would have tried anyways.
due to fixes in the underlying build system.
+
+num-cpus
+Cannot be overridden
+
+This option is automatically set by to the number of
+available CPUs (as indicated by the external application
+nproc). If cannot detect the
+number of CPUs, this value is set to 4.
+
+See for an example of this
+option's usage. This option was added in version 20.07.
+
+
+
override-build-system
Module setting overrides global
diff --git a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
index 122a3760..9196ea85 100644
--- a/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
+++ b/doc/kdesrc-buildrc/kdesrc-buildrc-overview.docbook
@@ -85,6 +85,25 @@ linkend="conf-use-modules">use-modules for more
information.
+
+Processing of option values
+
+In general, the entire line contents after the
+option-name is used as the
+option-value.
+
+One modification that performs is that a sequence
+${name-of-option} is replaced
+with the value of that option from the global configuration. This allows you
+to reference the value of existing options, including options already set by
+.
+
+
+To see an example of this in use, see
+.
+
+
+
options modules
