summaryrefslogtreecommitdiffstats
path: root/doc/global/includes/standardpath
diff options
context:
space:
mode:
authorJonathan Ketchker <iontankatchker@gmail.com>2023-08-27 12:45:04 +0300
committerJonathan Ketchker <iontankatchker@gmail.com>2023-09-07 01:17:13 +0300
commit55f0738f1638356137e6bd60459dc186ceaaabd8 (patch)
tree6d60bde37dab7ce24e32fb81145254d09e6c65a1 /doc/global/includes/standardpath
parent505ed52cd4dcef081d9868424057451bd1dce497 (diff)
Add StateLocation & GenericStateLocation to StandardLocation
The latest XDG spec (0.8) defines XDG_STATE_HOME that does not exist in QStandardPaths::StandardLocation. Some Linux distributions clean XDG_CACHE_HOME on restart which makes XDG_STATE_HOME useful as a path for saving application state. This commit adds StateLocation and GenericStateLocation to serve as a StandardLocation for XDG_STATE_HOME for all platforms. This commit also updates docs and tests to fit the new changes. [ChangeLog][QStandardPaths] Added StateLocation & GenericStateLocation to StandardLocation Change-Id: I470602466c37f085062cc64d15ea243711728fa5 Reviewed-by: David Faure <david.faure@kdab.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'doc/global/includes/standardpath')
-rw-r--r--doc/global/includes/standardpath/functiondocs.qdocinc4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/global/includes/standardpath/functiondocs.qdocinc b/doc/global/includes/standardpath/functiondocs.qdocinc
index c0f4763b90..5a008414c8 100644
--- a/doc/global/includes/standardpath/functiondocs.qdocinc
+++ b/doc/global/includes/standardpath/functiondocs.qdocinc
@@ -71,11 +71,13 @@
It affects the locations into which test programs might write
files: \c GenericDataLocation, \c AppDataLocation, \c ConfigLocation,
\c GenericConfigLocation, \c AppConfigLocation,
+ \c StateLocation, \c GenericStateLocation,
\c GenericCacheLocation, and \c CacheLocation. Other locations
are not affected.
On Unix, \c XDG_DATA_HOME is set to \c{~/.qttest/share},
- \c XDG_CONFIG_HOME is set to \c{~/.qttest/config}, and
+ \c XDG_CONFIG_HOME is set to \c{~/.qttest/config},
+ \c XDG_STATE_HOME is set \c{~/.qttest/state} and
\c XDG_CACHE_HOME is set to \c{~/.qttest/cache}.
On macOS, data goes to \c{~/.qttest/Application Support},