[glib] gfile: Clarify docs
- From: Benjamin Otte <otte src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] gfile: Clarify docs
- Date: Sat, 11 Oct 2014 23:57:53 +0000 (UTC)
commit e054bbfe1646239abc673658db314f546ff27709
Author: Benjamin Otte <otte redhat com>
Date: Sun Oct 12 01:57:02 2014 +0200
gfile: Clarify docs
Clarify corner cases that were unclear while reviewing a GTK patch.
gio/gfile.c | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
---
diff --git a/gio/gfile.c b/gio/gfile.c
index 61ddaac..0facca1 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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]