* [PATCH] doc/lib: clarify ownership for notmuch_database_get_revision
@ 2023-05-29 11:01 David Bremner
2023-07-09 15:11 ` David Bremner
0 siblings, 1 reply; 2+ messages in thread
From: David Bremner @ 2023-05-29 11:01 UTC (permalink / raw)
To: notmuch
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
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2023-07-09 15:11 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-05-29 11:01 [PATCH] doc/lib: clarify ownership for notmuch_database_get_revision David Bremner
2023-07-09 15:11 ` David Bremner
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).