Clarify that using the directory after destroying the corresponding database is not permitted.
This is implicit in the description of notmuch_database_destroy, but it doesn't hurt to be explicit, and we do express similar "ownership" relationships at other places in the docs. --- lib/notmuch.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/notmuch.h b/lib/notmuch.h index 68896ae..3df1ade 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -415,6 +415,10 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch); * If this directory object does not exist in the database, this * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL. * + * Otherwise the returned directory object is owned by the database + * and as such, will only be valid until notmuch_database_destroy is + * called. + * * Return value: * * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory. -- 1.8.5.2 _______________________________________________ notmuch mailing list [email protected] http://notmuchmail.org/mailman/listinfo/notmuch
