From a131beda54a15b071b6571b12f2f2ad8cb342c04 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Sun, 6 Jun 2010 05:25:59 +0200 Subject: [PATCH] [docs] Improve the g_get_system_config_dirs() docs. The retrieved list of directories is XDG_CONFIG_DIRS, Also mention the retrieved directory on Windows: CSIDL_COMMON_APPDATA --- glib/gutils.c | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/glib/gutils.c b/glib/gutils.c index 58ab9c9..4e7b000 100644 --- a/glib/gutils.c +++ b/glib/gutils.c @@ -2819,8 +2819,16 @@ g_get_system_data_dirs (void) * * On UNIX platforms this is determined using the mechanisms described in * the - * XDG Base Directory Specification - * + * XDG Base Directory Specification. + * In this case the list of directories retrieved will be XDG_CONFIG_DIRS. + * + * On Windows is the directory that contains application data for all users. + * A typical path is C:\Documents and Settings\All Users\Application Data. + * This folder is used for application data that is not user specific. + * For example, an application can store a spell-check dictionary, a database + * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder. + * This information will not roam and is available to anyone using the computer. + * * Return value: a %NULL-terminated array of strings owned by GLib that must * not be modified or freed. * Since: 2.6 -- 2.7.4