From 3d312e2577820f7c14df24be305da715d4ea74ee Mon Sep 17 00:00:00 2001 From: David Bremner Date: Wed, 7 Dec 2016 07:27:12 -0400 Subject: [PATCH] cli/insert: document the use of EX_TEMPFAIL --- doc/man1/notmuch-insert.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst index 9e7afc36..9847e674 100644 --- a/doc/man1/notmuch-insert.rst +++ b/doc/man1/notmuch-insert.rst @@ -60,6 +60,13 @@ indexing to Notmuch database, changing tags, and synchronizing tags to maildir flags. The ``--keep`` option may be used to settle for successful message file delivery. +This command supports the following special exit status code for +errors most likely to be temporary in nature, e.g. failure to get a +database write lock. + +``75 (EX_TEMPFAIL)`` + A temporary failure occured; the user is invited to retry. + The exit status of the **post-insert** hook does not affect the exit status of the **insert** command.