diff options
| author | David Bremner <david@tethera.net> | 2016-06-27 20:38:40 +0200 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2016-06-30 17:48:23 +0200 |
| commit | f2886b80c1addc3d358ba910a4eebf76ba74c00b (patch) | |
| tree | d3b70943f6df0da6147f313b5170286df5e01c3a /lib | |
| parent | 48d33532bb58c2ff61d687011dc0283e3ff536b0 (diff) | |
doc: forbid further operations on a closed database
We could add many null pointer checks, but currently I don't see a use
case that justifies it.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/notmuch.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h index cb46fc05..a43e167c 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -331,7 +331,9 @@ notmuch_database_status_string (const notmuch_database_t *notmuch); * functions on objects derived from this database may either behave * as if the database had not been closed (e.g., if the required data * has been cached) or may fail with a - * NOTMUCH_STATUS_XAPIAN_EXCEPTION. + * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation + * permitted on the database itself is to call + * notmuch_database_destroy. * * notmuch_database_close can be called multiple times. Later calls * have no effect. |