gfile: Clarify docs

Clarify corner cases that were unclear while reviewing a GTK patch.
This commit is contained in:
Benjamin Otte 2014-10-12 01:57:02 +02:00
parent 6e994d0656
commit e054bbfe16

View File

@ -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