From: David Bremner <david@tethera.net>
Date: Wed, 7 Dec 2016 11:27:12 +0000 (-0400)
Subject: cli/insert: document the use of EX_TEMPFAIL
X-Git-Tag: 0.23.4~7
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=3d312e2577820f7c14df24be305da715d4ea74ee;ds=sidebyside

cli/insert: document the use of EX_TEMPFAIL
---

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.