doc/lib: clarify ownership for notmuch_database_get_revision

[notmuch] / lib / notmuch.h

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 7615617877504ff81e9b4dee005218ab7a8d023c..4e2b0fa48d3daf46dc75f51ded735a95424e9477 100644 (file)
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -722,7 +722,8 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch);
  *
  * The UUID is a NUL-terminated opaque string that uniquely identifies
  * this database.  Two revision numbers are only comparable if they
- * have the same database UUID.
+ * have the same database UUID. The string 'uuid' is owned by notmuch
+ * and should not be freed or modified by the user.
  */
 unsigned long
 notmuch_database_get_revision (notmuch_database_t *notmuch,