[PATCH] doc/lib: clarify ownership for notmuch_database_get_revision

Subject: [PATCH] doc/lib: clarify ownership for notmuch_database_get_revision

Date: Mon, 29 May 2023 08:01:40 -0300

To: notmuch@notmuchmail.org

Cc:

From: David Bremner

The ownership is implicit in the const declaration (I think!), but
that does not show up in the doxygen generated API docs.
---
 lib/notmuch.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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,
-- 
2.39.2

_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: