From: David Bremner <david@tethera.net>
Date: Mon, 29 May 2023 11:01:40 +0000 (-0300)
Subject: doc/lib: clarify ownership for notmuch_database_get_revision
X-Git-Tag: 0.38_rc0~16
X-Git-Url: https://git.cworth.org/git?p=notmuch;a=commitdiff_plain;h=a62b8a95c0e890f11cb39cc2aaea3a4893c8268d

doc/lib: clarify ownership for notmuch_database_get_revision

The ownership is implicit in the const declaration (I think!), but
that does not show up in the doxygen generated API docs.
---

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 76156178..4e2b0fa4 100644
--- 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,