[tracker/tracker-0.10] libtracker-miner: Improve docs for tracker_miner_manager_pause_for_process()

[Martyn James Russell <mr src gnome org>]

commit 6234e3a24217d046fd821a35a99a434c22b46777
Author: Martyn Russell <martyn lanedo com>
Date:   Wed Sep 21 14:16:39 2011 +0100

    libtracker-miner: Improve docs for tracker_miner_manager_pause_for_process()
    
    When finalizing the manager, it will resume the pause. The tracker-control
    utility was demonstrating this. Let people calling it know.

 src/libtracker-miner/tracker-miner-manager.c |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-miner-manager.c b/src/libtracker-miner/tracker-miner-manager.c
index 3e78705..fc9f7ae 100644
--- a/src/libtracker-miner/tracker-miner-manager.c
+++ b/src/libtracker-miner/tracker-miner-manager.c
@@ -901,6 +901,10 @@ tracker_miner_manager_pause (TrackerMinerManager *manager,
  * where the calling process has a risk of crashing without resuming
  * the pause.
  *
+ * NOTE: If you call g_object_unref() on the @manager before you
+ * intend to resume the pause and it finalizes, it will automatically
+ * resume.
+ *
  * Returns: %TRUE if the miner was paused successfully, otherwise
  * %FALSE.
  *