From 2ac118f80c84998d7fd0e8a41b04152b2fca347e Mon Sep 17 00:00:00 2001
From: Geert Janssens <geert@kobaltwit.be>
Date: Sat, 16 Sep 2017 19:33:56 +0200
Subject: [PATCH] Improve a few comments.

---
 libgnucash/core-utils/gnc-filepath-utils.cpp                | 6 ++++++
 libgnucash/core-utils/test/test-userdata-dir-invalid-home.c | 6 ++++--
 libgnucash/core-utils/test/test-userdata-dir.c              | 2 +-
 3 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/libgnucash/core-utils/gnc-filepath-utils.cpp b/libgnucash/core-utils/gnc-filepath-utils.cpp
index d3e7ca747e..f2316adb10 100644
--- a/libgnucash/core-utils/gnc-filepath-utils.cpp
+++ b/libgnucash/core-utils/gnc-filepath-utils.cpp
@@ -554,6 +554,12 @@ gnc_filepath_init(gboolean create)
             }
         }
 
+        /* The fall back to the tmp dir is to accomodate for very restricted
+         * distribution build environments. In some such cases
+         * there is no home directory available, which would cause the build
+         * to fail (as this code is actually run while compiling guile scripts).
+         * This is worked around by continuing with a userdata directory
+         * in the temporary directory which always exists. */
         if (!userdata_is_home)
             gnc_userdata_home = userdata_home / PACKAGE_NAME;
         gnc_userdata_home_exists = bfs::exists(gnc_userdata_home);
diff --git a/libgnucash/core-utils/test/test-userdata-dir-invalid-home.c b/libgnucash/core-utils/test/test-userdata-dir-invalid-home.c
index 0195c43058..f6108c174e 100644
--- a/libgnucash/core-utils/test/test-userdata-dir-invalid-home.c
+++ b/libgnucash/core-utils/test/test-userdata-dir-invalid-home.c
@@ -1,5 +1,5 @@
 /***************************************************************************
- *            test-resolve-file-path.c
+ *            test-userdata-dir-invalid-home.c
  *
  *  Thu Sep 29 22:48:57 2005
  *  Copyright  2005  GnuCash team
@@ -65,7 +65,9 @@ main(G_GNUC_UNUSED int argc, G_GNUC_UNUSED char **argv)
     int i;
     const char *tmp_dir = g_get_tmp_dir();
 
-    /* Run usr conf dir tests with a valid and writable homedir */
+    /* Run usr conf dir tests with an invalid homedir
+     * The code should fall back to using the temporary
+     * directory in that case. */
     g_setenv("HOME", "/notexist", TRUE);
     for (i = 0; strs2[i].funcname != NULL; i++)
     {
diff --git a/libgnucash/core-utils/test/test-userdata-dir.c b/libgnucash/core-utils/test/test-userdata-dir.c
index 3197a0b406..7046336f45 100644
--- a/libgnucash/core-utils/test/test-userdata-dir.c
+++ b/libgnucash/core-utils/test/test-userdata-dir.c
@@ -1,5 +1,5 @@
 /***************************************************************************
- *            test-resolve-file-path.c
+ *            test-userdata-dir.c
  *
  *  Thu Sep 29 22:48:57 2005
  *  Copyright  2005  GnuCash team