IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Adjust gnc_userconfig_dir and get_userconfig_home to the former returns a subdirectory of the latter

Browse Source 
Also add a few comments to make the distinction more clear.
This commit is contained in:
Geert Janssens 2018-02-19 20:30:36 +01:00
parent 27256357f5
commit 62fd179f87
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
libgnucash/core-utils/gnc-filepath-utils.cpp
View File

@ -492,6 +492,12 @@ quarz_get_userdata_home(void)
}
#endif
/* Returns an absolute path to the user's data directory.
* Note the default path depends on the platform.
* - Windows: CSIDL_APPDATA
* - OS X: $HOME/Application Support
* - Linux: $XDG_DATA_HOME (or the default $HOME/.local/share)
*/
static bfs::path
get_userdata_home(void)
{
@ -543,6 +549,12 @@ get_userdata_home(void)
return userdata_home;
}
/* Returns an absolute path to the user's config directory.
* Note the default path depends on the platform.
* - Windows: CSIDL_APPDATA
* - OS X: $HOME/Application Support
* - Linux: $XDG_CONFIG_HOME (or the default $HOME/.config)
*/
static bfs::path
get_userconfig_home(void)
{
@ -565,8 +577,6 @@ get_userconfig_home(void)
else
userconfig_home = g_get_user_config_dir();
userconfig_home = userconfig_home / PACKAGE;
return userconfig_home;
}
@ -670,12 +680,12 @@ gnc_filepath_init (void)
* Note that the default path depends on the platform.
* - Windows: CSIDL_APPDATA/Gnucash
* - OS X: $HOME/Application Support/Gnucash
* - Linux: $XDG_DATA_HOME/Gnucash (or the default $HOME/.local/share/Gnucash)
* - Linux: $XDG_DATA_HOME/gnucash (or the default $HOME/.local/share/gnucash)
*
* If any of these paths doesn't exist and can't be created the function will
* If any of these paths don't exist and can't be created the function will
* fall back to
* - $HOME/.gnucash
* - <TMP_DIR>/Gnucash
* - <TMP_DIR>/gnucash
* (in that order)
*
* @return An absolute path to the configuration directory. This string is
@ -712,12 +722,14 @@ gnc_userdata_dir (void)
}
/** @fn const gchar * gnc_userconfig_dir ()
* @brief Return the config directory
* @brief Return the user's config directory for gnucash
*
* Note that the default path depends on the platform.
* @note the default path depends on the platform.
* - Windows: CSIDL_APPDATA/Gnucash
* - OS X: $HOME/Application Support/Gnucash
* - Linux: $XDG_CONFIG_HOME/Gnucash (or the default $HOME/.config/Gnucash)
* - Linux: $XDG_CONFIG_HOME/gnucash (or the default $HOME/.config/gnucash)
*
* @note gnucash will not create this directory if it doesn't exist
*
* @return An absolute path to the configuration directory. This string is
* owned by the gnc_filepath_utils code and should not be freed by the user.
@ -725,7 +737,7 @@ gnc_userdata_dir (void)
const gchar *
gnc_userconfig_dir (void)
{
auto path_string = get_userconfig_home();
auto path_string = get_userconfig_home() / PACKAGE;
return g_strdup(path_string.string().c_str());
}