Skip to content
  • Paul Tan's avatar
    path.c: implement xdg_config_home() · ea19289b
    Paul Tan authored and Junio C Hamano's avatar Junio C Hamano committed
    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
    
    
    
    Helped-by: default avatarEric Sunshine <sunshine@sunshineco.com>
    Signed-off-by: default avatarPaul Tan <pyokagan@gmail.com>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    ea19289b