[gio] Improve doc for g_file_make_directory_with_parents()
authorBastien Nocera <hadess@hadess.net>
Mon, 3 Oct 2011 14:27:15 +0000 (15:27 +0100)
committerBastien Nocera <hadess@hadess.net>
Tue, 4 Oct 2011 16:10:39 +0000 (17:10 +0100)
g_file_make_directory_with_parents() will fail for already
existing directories, unlike g_mkdir_with_parents(), so mention
this clearly in the docs.

https://bugzilla.gnome.org/show_bug.cgi?id=660791

gio/gfile.c

index dcd7433..442afe0 100644 (file)
@@ -3373,7 +3373,9 @@ g_file_make_directory (GFile         *file,
  *
  * Creates a directory and any parent directories that may not exist similar to
  * 'mkdir -p'. If the file system does not support creating directories, this
- * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED.
+ * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the
+ * directory itself already exists, this function will fail setting @error
+ * to %G_IO_ERROR_EXISTS, unlike the similar g_mkdir_with_parents().
  * 
  * For a local #GFile the newly created directories will have the default
  * (current) ownership and permissions of the current process.