summaryrefslogtreecommitdiff
path: root/gio/gfile.c
diff options
context:
space:
mode:
authorBenjamin Otte <otte@redhat.com>2014-10-12 01:57:02 +0200
committerBenjamin Otte <otte@redhat.com>2014-10-12 01:57:02 +0200
commite054bbfe1646239abc673658db314f546ff27709 (patch)
treece3ef6c9cacc2ea5a86e98c8908c379372626f1a /gio/gfile.c
parent6e994d06560bdb36921eef8338681caf95d90102 (diff)
downloadglib-e054bbfe1646239abc673658db314f546ff27709.tar.gz
glib-e054bbfe1646239abc673658db314f546ff27709.tar.bz2
glib-e054bbfe1646239abc673658db314f546ff27709.zip
gfile: Clarify docs
Clarify corner cases that were unclear while reviewing a GTK patch.
Diffstat (limited to 'gio/gfile.c')
-rw-r--r--gio/gfile.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/gio/gfile.c b/gio/gfile.c
index 61ddaaccd..0facca16e 100644
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -641,7 +641,7 @@ g_file_hash (gconstpointer file)
* @file1: the first #GFile
* @file2: the second #GFile
*
- * Checks equality of two given #GFiles.
+ * Checks if the two given #GFiles refer to the same file.
*
* Note that two #GFiles that differ can still refer to the same
* file on the filesystem due to various forms of filename
@@ -810,6 +810,9 @@ g_file_get_child_for_display_name (GFile *file,
* so a path like /foo is not considered a prefix of /foobar, only
* of /foo/bar.
*
+ * A #GFile is not a prefix of itself. If you want to check for
+ * equality, use g_file_equal().
+ *
* This call does no I/O, as it works purely on names. As such it can
* sometimes return %FALSE even if @file is inside a @prefix (from a
* filesystem point of view), because the prefix of @file is an alias