diff options
| author | Alexander Lohnau <alexander.lohnau@gmx.de> | 2021-09-14 07:30:32 +0200 |
|---|---|---|
| committer | Alexander Lohnau <alexander.lohnau@gmx.de> | 2021-09-19 07:50:10 +0200 |
| commit | 0b0a4464fb3d1145eb612b1ab7edacfa9581c8c9 (patch) | |
| tree | db94f2c4daba14f23e13aa65d55a05257f86ab41 /src/kconfig_compiler/README.dox | |
| parent | 782750149a0819053d47960fb144f17b7c719d13 (diff) | |
| download | kconfig-0b0a4464fb3d1145eb612b1ab7edacfa9581c8c9.tar.gz kconfig-0b0a4464fb3d1145eb612b1ab7edacfa9581c8c9.tar.bz2 | |
Allow KConfigXT to use KSharedConfig::openStateConfig
Otherwise we force consumers to use the config location for state data,
which is what we are trying to avoid.
Task: https://phabricator.kde.org/T12549
Diffstat (limited to 'src/kconfig_compiler/README.dox')
| -rw-r--r-- | src/kconfig_compiler/README.dox | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/kconfig_compiler/README.dox b/src/kconfig_compiler/README.dox index 671e9c5b..4c22a452 100644 --- a/src/kconfig_compiler/README.dox +++ b/src/kconfig_compiler/README.dox @@ -385,6 +385,11 @@ Example 1: In this case passing "Group2" as the 'groupname' parameter to the generated class will make it use group "Group2" for the entry "Text". +By setting the stateConfig attribute of kcfgfile to "true", KSharedConfig::openStateConfig is used. +This should be used when one stores volatile data, like window sizes or autocompletion texts. +It is recommended to have at least two separate kcfg files for the different kinds of data. +NOTE: This option is ignored when ForceStringFilename is set. + \subsection enums Enums By default, if <b>GlobalEnums</b> is set to false, a separate named enum will be generated |