summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Lagerwall <rosslagerwall@gmail.com>2014-09-08 21:09:08 +0100
committerRoss Lagerwall <rosslagerwall@gmail.com>2014-10-30 20:19:14 +0000
commit0728e62be8bf247f9d097822efd26312367ff133 (patch)
tree8251f3fe8e61861eceb8884e7dc03c0e28636b21
parent226c292b6ab95014648e9fc0a082bb6c26eeccc8 (diff)
downloadglib-0728e62be8bf247f9d097822efd26312367ff133.tar.gz
doc: Clarify documentation regarding g_file_replace and etags
Clarify that with g_file_replace, a non-NULL etag is only checked if the file already exists. https://bugzilla.gnome.org/show_bug.cgi?id=736286
-rw-r--r--gio/gfile.c16
1 files changed, 8 insertions, 8 deletions
diff --git a/gio/gfile.c b/gio/gfile.c
index 2e1e3cbde..3e2607c8d 100644
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -1724,14 +1724,14 @@ g_file_create (GFile *file,
* operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
* returned.
*
- * If you pass in a non-%NULL @etag value, then this value is
- * compared to the current entity tag of the file, and if they differ
- * an %G_IO_ERROR_WRONG_ETAG error is returned. This generally means
- * that the file has been changed since you last read it. You can get
- * the new etag from g_file_output_stream_get_etag() after you've
- * finished writing and closed the #GFileOutputStream. When you load
- * a new file you can use g_file_input_stream_query_info() to get
- * the etag of the file.
+ * If you pass in a non-%NULL @etag value and @file already exists, then
+ * this value is compared to the current entity tag of the file, and if
+ * they differ an %G_IO_ERROR_WRONG_ETAG error is returned. This
+ * generally means that the file has been changed since you last read
+ * it. You can get the new etag from g_file_output_stream_get_etag()
+ * after you've finished writing and closed the #GFileOutputStream. When
+ * you load a new file you can use g_file_input_stream_query_info() to
+ * get the etag of the file.
*
* If @make_backup is %TRUE, this function will attempt to make a
* backup of the current file before overwriting it. If this fails