From 5cc52b242e5a4380e3aea6c53606f756d0a3a48a Mon Sep 17 00:00:00 2001
From: Peter Palfrader <peter@palfrader.org>
Date: Mon, 15 Jul 2013 10:46:11 +0200
Subject: [PATCH] Document get_parent_directory more

---
 src/common/compat.c | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/common/compat.c b/src/common/compat.c
index 69eb0643d0..391f175c42 100644
--- a/src/common/compat.c
+++ b/src/common/compat.c
@@ -1746,6 +1746,15 @@ get_user_homedir(const char *username)
  * actually examine the filesystem; does a purely syntactic modification.
  *
  * The parent of the root director is considered to be iteself.
+ *
+ * Path separators are the forward slash (/) everywhere and additionally
+ * the backslash (\) on Win32.
+ *
+ * Cuts off any number of trailing path separators but otherwise ignores
+ * them for purposes of finding the parent directory.
+ *
+ * Returns 0 if a parent directory was successfully found, -1 otherwise (fname
+ * did not have any path separators or only had them ad the end).
  * */
 int
 get_parent_directory(char *fname)