[PATCH 1/2] cli/insert: document the use of EX_TEMPFAIL

Subject: [PATCH 1/2] cli/insert: document the use of EX_TEMPFAIL

Date: Wed, 7 Dec 2016 07:27:12 -0400

To: Tomi Ollila, David Bremner, Maarten Aertsen, Notmuch Mail

Cc:

From: David Bremner


---
 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 9e7afc3..9847e67 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.
 
-- 
2.10.2


Thread: