Clarify semantics of g_volume_mount_finish() (#552168)

2008-09-29  David Zeuthen  <davidz@redhat.com>

        * gvolume.c: Clarify semantics of g_volume_mount_finish() (#552168)

svn path=/trunk/; revision=7559

diff --git a/gio/ChangeLog b/gio/ChangeLog
index a15e75e..a1ee3f5 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,7 @@
+2008-09-29  David Zeuthen  <davidz@redhat.com>
+
+       * gvolume.c: Clarify semantics of g_volume_mount_finish() (#552168)
+
 2008-09-26  Dan Winship  <danw@gnome.org>
 
        * tests/data-input-stream.c:

diff --git a/gio/gvolume.c b/gio/gvolume.c
index 88276aa..7607b42 100644 (file)
--- a/gio/gvolume.c
+++ b/gio/gvolume.c
@@ -383,6 +383,11 @@ g_volume_mount (GVolume             *volume,
  * 
  * Finishes mounting a volume. If any errors occured during the operation,
  * @error will be set to contain the errors and %FALSE will be returned.
+ *
+ * If the mount operation succeeded, g_volume_get_mount() on @volume
+ * is guaranteed to return the mount right after calling this
+ * function; there's no need to listen for the 'mount-added' signal on
+ * #GVolumeMonitor.
  * 
  * Returns: %TRUE, %FALSE if operation failed.
  **/