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.
This commit is contained in:
Colin Walters 2012-07-30 05:11:08 -04:00
parent 14a1c20177
commit d7829ced53

View File

@ -3483,7 +3483,7 @@ g_file_make_symbolic_link (GFile *file,
* @error: a #GError, or %NULL * @error: a #GError, or %NULL
* *
* Deletes a file. If the @file is a directory, it will only be deleted if it * 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 * If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation * 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 * @user_data: the data to pass to callback function
* *
* Asynchronously delete a file. If the @file is a directory, it will * 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 * Virtual: delete_file_async
* Since: 2.34 * Since: 2.34