diff options
| author | David Bremner <david@tethera.net> | 2016-06-27 20:38:40 +0200 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2016-06-28 23:20:38 +0200 |
| commit | 38f0d44a82d4a6584bd95f611dfb429057a37b62 (patch) | |
| tree | 5991531d39f61822dc0007deffbdf7f79ced09a4 /lib | |
| parent | be55acf4f0379b964e8c85cb20e2834b25842f4d (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 d4a97cb8..2faa1468 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -332,7 +332,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. |