Document that the new_etags output gchar* should be freed.

2008-01-27  Murray Cumming  <murrayc@murrayc.com>

* gio/gfile.c: (g_file_replace_contents),
(g_file_replace_contents_finish): Document that the new_etags output
gchar* should be freed.

svn path=/trunk/; revision=6383

diff --git a/ChangeLog b/ChangeLog
index 71a3784..520dab3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-01-27  Murray Cumming  <murrayc@murrayc.com>
+
+       * gio/gfile.c: (g_file_replace_contents),
+       (g_file_replace_contents_finish): Document that the new_etags output 
+       gchar* should be freed.
+
 2008-01-25  Loïc Minier  <lool@dooz.org>
 
        * glib/goption.c: (group_has_visible_entries),

diff --git a/gio/gfile.c b/gio/gfile.c
index 69c2931..85c7bf4 100644 (file)
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -5021,7 +5021,8 @@ g_file_load_contents_finish (GFile         *file,
  * @make_backup: %TRUE if a backup should be created.
  * @flags: a set of #GFileCreateFlags.
  * @new_etag: a location to a new <link linkend="gfile-etag">entity tag</link>
- *      for the document.
+ *      for the document. This should be freed with g_free() when no longer 
+ *      needed.
  * @cancellable: optional #GCancellable object, %NULL to ignore.
  * @error: a #GError, or %NULL
  *
@@ -5290,7 +5291,8 @@ g_file_replace_contents_async  (GFile               *file,
  * @file: input #GFile.
  * @res: a #GAsyncResult. 
  * @new_etag: a location of a new <link linkend="gfile-etag">entity tag</link> 
- *     for the document.
+ *     for the document. This should be freed with g_free() when it is no 
+ *     longer needed.
  * @error: a #GError, or %NULL 
  * 
  * Finishes an asynchronous replace of the given @file. See