diff options
author | Harald Sitter <sitter@kde.org> | 2019-02-27 14:58:17 +0100 |
---|---|---|
committer | Harald Sitter <sitter@kde.org> | 2019-03-01 11:32:16 +0100 |
commit | d22f469be6fdd90fdd3a21a36b8441dcf4d60f46 (patch) | |
tree | 45ec85aeea6dc5143735ae248156751ce8036b5b | |
parent | 3bfe329b7136a58f20bd0f9011f20b2a4c65c0fe (diff) | |
download | kconfig-d22f469be6fdd90fdd3a21a36b8441dcf4d60f46.tar.gz kconfig-d22f469be6fdd90fdd3a21a36b8441dcf4d60f46.tar.bz2 |
improve documentation on global config cascading
Summary:
the previous description of IncludeGlobals was a bit lackluster. the new
description should make it more obvious what the various flag permutations
achieve.
BUG: 306923
Reviewers: kde-frameworks-devel, apol
Reviewed By: apol
Subscribers: kde-frameworks-devel
Tags: #frameworks
Differential Revision: https://phabricator.kde.org/D19388
-rw-r--r-- | src/core/kconfig.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/core/kconfig.h b/src/core/kconfig.h index 5b341232..b771b881 100644 --- a/src/core/kconfig.h +++ b/src/core/kconfig.h @@ -77,7 +77,10 @@ public: * to provide defaults for the settings accessed through this object, or * possibly to override those settings in certain cases. * - * IncludeGlobals does the same, but with the global settings sources. + * If IncludeGlobals is selected, the kdeglobals configuration is used + * as additional configuration sources to provide defaults. Additionally + * selecting CascadeConfig will result in the system-wide kdeglobals sources + * also getting included. * * Note that the main configuration source overrides the cascaded sources, * which override those provided to addConfigSources(), which override the |