From a9de33643b1503b87359bda0828beeea2ed0162e Mon Sep 17 00:00:00 2001 From: Jonathan Arnett Date: Fri, 28 Apr 2017 11:26:39 -0400 Subject: [PATCH] Appended to comment --- lib/pure/ospaths.nim | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/pure/ospaths.nim b/lib/pure/ospaths.nim index 4c667dd92d..050482279c 100644 --- a/lib/pure/ospaths.nim +++ b/lib/pure/ospaths.nim @@ -516,6 +516,14 @@ when declared(getEnv) or defined(nimscript): proc getConfigDir*(): string {.rtl, extern: "nos$1", tags: [ReadEnvEffect, ReadIOEffect].} = ## Returns the config directory of the current user for applications. + ## + ## On non-Windows OSs, this proc conforms to the XDG Base Directory + ## spec. Thus, this proc returns the value of the XDG_CONFIG_DIR environment + ## variable if it is set, and returns the default configuration directory, + ## "~/.config/", otherwise. + ## + ## An OS-dependent trailing slash is always present at the end of the + ## returned string; `\\` on Windows and `/` on all other OSs. when defined(windows): return string(getEnv("APPDATA")) & "\\" elif getEnv("XDG_CONFIG_DIR"): return string(getEnv("XDG_CONFIG_DIR")) & "/" else: return string(getEnv("HOME")) & "/.config/"