Commit 0e6467af authored by Philip Withnall's avatar Philip Withnall
Browse files

gutils: Document caching of XDG directory variables

See: #2278

.
Signed-off-by: Philip Withnall's avatarPhilip Withnall <pwithnall@endlessos.org>
parent 0727983d
......@@ -1732,6 +1732,9 @@ g_build_user_data_dir (void)
* Note that in this case on Windows it will be the same
* as what g_get_user_config_dir() returns.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename) (transfer none): a string owned by GLib that must
* not be modified or freed.
*
......@@ -1793,6 +1796,9 @@ g_build_user_config_dir (void)
* Note that in this case on Windows it will be the same
* as what g_get_user_data_dir() returns.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename) (transfer none): a string owned by GLib that
* must not be modified or freed.
* Since: 2.6
......@@ -1852,6 +1858,9 @@ g_build_user_cache_dir (void)
* `C:\Documents and Settings\username\Local Settings\Temporary Internet Files`.
* See the [documentation for `CSIDL_INTERNET_CACHE`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_internet_cache).
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename) (transfer none): a string owned by GLib that
* must not be modified or freed.
* Since: 2.6
......@@ -1914,6 +1923,9 @@ g_build_user_runtime_dir (void)
* In the case that this variable is not set, we return the value of
* g_get_user_cache_dir(), after verifying that it exists.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename): a string owned by GLib that must not be
* modified or freed.
*
......@@ -2536,6 +2548,9 @@ g_build_system_data_dirs (void)
* Note that on Windows the returned list can vary depending on where
* this function is called.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (array zero-terminated=1) (element-type filename) (transfer none):
* a %NULL-terminated array of strings owned by GLib that must not be
* modified or freed.
......@@ -2611,6 +2626,9 @@ g_build_system_config_dirs (void)
* CSIDL_COMMON_APPDATA folder. This information will not roam and is available
* to anyone using the computer.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (array zero-terminated=1) (element-type filename) (transfer none):
* a %NULL-terminated array of strings owned by GLib that must not be
* modified or freed.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment