GFile: Note semantics of g_file_delete()

Particularly for someone programming on Unix, this helps them
understand that we will unlink symbolic links, and not follow them.

diff --git a/gio/gfile.c b/gio/gfile.c
index b76939f..f664875 100644 (file)
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -3483,7 +3483,7 @@ g_file_make_symbolic_link (GFile         *file,
  * @error: a #GError, or %NULL 
  * 
  * Deletes a file. If the @file is a directory, it will only be deleted if it 
- * is empty.
+ * is empty.  This has the same semantics as g_unlink().
  * 
  * If @cancellable is not %NULL, then the operation can be cancelled by
  * triggering the cancellable object from another thread. If the operation
@@ -3527,7 +3527,8 @@ g_file_delete (GFile         *file,
  * @user_data: the data to pass to callback function
  *
  * Asynchronously delete a file. If the @file is a directory, it will
- * only be deleted if it is empty.
+ * only be deleted if it is empty.  This has the same semantics as
+ * g_unlink().
  *
  * Virtual: delete_file_async
  * Since: 2.34