[glib] gfile: Clarify g_file_get_path() documentation



commit 50a65cc38a68dcb04f57fb492c83878e5238d15b
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Mon Aug 24 10:37:51 2015 +0100

    gfile: Clarify g_file_get_path() documentation
    
    Clarify that the returned path (if non-NULL) is guaranteed to be
    absolute and canonical, but might still contain symlinks.

 gio/gfile.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)
---
diff --git a/gio/gfile.c b/gio/gfile.c
index 851be01..bbb0abd 100644
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -512,7 +512,8 @@ g_file_get_basename (GFile *file)
  * g_file_get_path:
  * @file: input #GFile
  *
- * Gets the local pathname for #GFile, if one exists.
+ * Gets the local pathname for #GFile, if one exists. If non-%NULL, this is
+ * guaranteed to be an absolute, canonical path. It might contain symlinks.
  *
  * This call does no blocking I/O.
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]