From 4bfac00aa389487c4f11d34e7a3e96e4a1116800 Mon Sep 17 00:00:00 2001
From: Rui Abreu Ferreira <raf-ep@gmx.com>
Date: Tue, 27 Oct 2015 00:23:48 +0000
Subject: [PATCH] Windows: XDG: Update default paths. #4403

The previous defaults were including the nvim suffix, causing it to
apear twice in the final paths.

kXDGDataHome and kXDGConfigHome are now set as %LOCALAPPDATA%,
kXDGCacheHome is set as $TEMP.

In Windows there is no distinction between configuration and data
storage, but we don't want to place all files under the same path.
get_xdg_home() now appends a different path suffix for kXDGDataHome.

- Configuration files are saved under %LOCALAPPDATA%\nvim
- Data files are saved under %LOCALAPPDATA%\nvim-data
---
 runtime/doc/starting.txt |  2 ++
 runtime/doc/usr_05.txt   |  5 +++--
 src/nvim/os/stdpaths.c   | 14 +++++++++++---
 3 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt
index be108d4633..37593aef43 100644
--- a/runtime/doc/starting.txt
+++ b/runtime/doc/starting.txt
@@ -380,6 +380,8 @@ accordingly.  Vim proceeds in this order:
 	Places for your personal initializations:
 		Unix		$XDG_CONFIG_HOME/nvim/init.vim
 				(default for $XDG_CONFIG_HOME is ~/.config)
+		Windows		$XDG_CONFIG_HOME/nvim/init.vim
+				(default for $XDG_CONFIG_HOME is ~/AppData/Local)
 
 	The files are searched in the order specified above and only the first
 	one that is found is read.
diff --git a/runtime/doc/usr_05.txt b/runtime/doc/usr_05.txt
index 86fcf0cc2f..5aecf33557 100644
--- a/runtime/doc/usr_05.txt
+++ b/runtime/doc/usr_05.txt
@@ -37,9 +37,10 @@ for you), you can edit it this way: >
 If you don't have a vimrc file yet, see |init.vim| to find out where you can
 create a vimrc file.
 
-For Unix and Macintosh this file is always used and is recommended:
+This file is always used and is recommended:
 
-	~/.config/nvim/init.vim ~
+	~/.config/nvim/init.vim         (Unix and OSX) ~
+	~/AppData/Local/nvim/init.vim   (Windows) ~
 
 The vimrc file can contain all the commands that you type after a colon.  The
 most simple ones are for setting options.  For example, if you want Vim to
diff --git a/src/nvim/os/stdpaths.c b/src/nvim/os/stdpaths.c
index c9631a434c..8a8f43cb8a 100644
--- a/src/nvim/os/stdpaths.c
+++ b/src/nvim/os/stdpaths.c
@@ -22,9 +22,9 @@ static const char *xdg_env_vars[] = {
 static const char *const xdg_defaults[] = {
 #ifdef WIN32
   // Windows
-  [kXDGConfigHome] = "$LOCALAPPDATA\\nvim\\config",
-  [kXDGDataHome]   = "$LOCALAPPDATA\\nvim\\data",
-  [kXDGCacheHome]  = "$LOCALAPPDATA\\nvim\\cache",
+  [kXDGConfigHome] = "$LOCALAPPDATA",
+  [kXDGDataHome]   = "$LOCALAPPDATA",
+  [kXDGCacheHome]  = "$TEMP",
   [kXDGRuntimeDir] = NULL,
   [kXDGConfigDirs] = NULL,
   [kXDGDataDirs] = NULL,
@@ -66,12 +66,20 @@ char *stdpaths_get_xdg_var(const XDGVarType idx)
 /// @param[in]  idx  XDG directory to use.
 ///
 /// @return [allocated] `{xdg_directory}/nvim`
+///
+/// In WIN32 get_xdg_home(kXDGDataHome) returns `{xdg_directory}/nvim-data` to
+/// avoid storing configuration and data files in the same path.
 static char *get_xdg_home(const XDGVarType idx)
   FUNC_ATTR_WARN_UNUSED_RESULT
 {
   char *dir = stdpaths_get_xdg_var(idx);
   if (dir) {
+#if defined(WIN32)
+    dir = concat_fnames_realloc(dir, (idx == kXDGDataHome ? "nvim-data" : "nvim"),
+                                true);
+#else
     dir = concat_fnames_realloc(dir, "nvim", true);
+#endif
   }
   return dir;
 }