From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH] doc/lib: clarify ownership for notmuch_database_get_revision
Date: Mon, 29 May 2023 08:01:40 -0300 [thread overview]
Message-ID: <20230529110140.2094248-1-david@tethera.net> (raw)
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
next reply other threads:[~2023-05-29 11:01 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-29 11:01 David Bremner [this message]
2023-07-09 15:11 ` [PATCH] doc/lib: clarify ownership for notmuch_database_get_revision David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230529110140.2094248-1-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).