Paul Tan[PATCH 1/7] path.c: implement xdg_config_home()
The XDG base dir spec[1] specifies that configuration files be stored in a subdirectory in $XDG_CONFIG_HOME. To construct such a configuration file path, home_config_paths() can be used. However, home_config_paths() combines distinct functionality:
1. Retrieve the home git config file path ~/.gitconfig
2. Construct the XDG config path of the file specified by `file`.
This function was introduced in commit 21cf3227 ("read (but not write) from $XDG_CONFIG_HOME/git/config file"). While the intention of the function was to allow the home directory configuration file path and the xdg directory configuration file path to be retrieved with one function call, the hard-coding of the path ~/.gitconfig prevents it from being used for other configuration files. Furthermore, retrieving a file path relative to the user's home directory can be done with expand_user_path(). Hence, it can be seen that home_config_paths() introduces unnecessary complexity, especially if a user just wants to retrieve the xdg config file path.
As such, implement a simpler function xdg_config_home() for constructing the XDG base dir spec configuration file path. This function, together with expand_user_path(), can replace all uses of home_config_paths().
[1] http://standards.freedesktop.org/basedir-spec/basedir-spec-0.7.html
Signed-off-by: Paul Tan <pyokagan@gmail.com> --- cache.h | 7 +++++++ path.c | 16 ++++++++++++++++ 2 files changed, 23 insertions(+)
Show changes to 2 files +23 −0
cache.h, path.c
diff --git a/cache.h b/cache.h index 3d3244b..7f9bab0 100644 --- a/cache.h +++ b/cache.h @@ -836,6 +836,13 @@ char *strip_path_suffix(const char *path, const char *suffix); int daemon_avoid_alias(const char *path); extern int is_ntfs_dotgit(const char *name); +/** + * Returns the newly allocated string "$XDG_CONFIG_HOME/git/%s". If + * $XDG_CONFIG_HOME is unset or empty, returns the newly allocated string + * "$HOME/.config/git/%s". Returns NULL if an error occurred. + */ +extern char *xdg_config_home(const char *fn); + /* object replacement */ #define LOOKUP_REPLACE_OBJECT 1 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag); diff --git a/path.c b/path.c index e608993..4c32d16 100644 --- a/path.c +++ b/path.c @@ -856,3 +856,19 @@ int is_ntfs_dotgit(const char *name) len = -1; } } + +char *xdg_config_home(const char *fn) +{ + const char *config_home = getenv("XDG_CONFIG_HOME"); + + if (!fn) + fn = ""; + if (!config_home || !config_home[0]) { + const char *home = getenv("HOME"); + + if (!home) + return NULL; + return mkpathdup("%s/.config/git/%s", home, fn); + } else + return mkpathdup("%s/git/%s", config_home, fn); +}
-- 2.1.4
