[PATCH v2 10/10] man: update insert documentation

diff --git a/44/3c5027dd2edcf5f9b85f72c6fef2df1df73044 b/44/3c5027dd2edcf5f9b85f72c6fef2df1df73044
new file mode 100644 (file)
index 0000000..921061e
--- /dev/null
+++ b/44/3c5027dd2edcf5f9b85f72c6fef2df1df73044
@@ -0,0 +1,110 @@
+Return-Path: <novalazy@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 90B63429E31\r
+       for <notmuch@notmuchmail.org>; Wed, 16 Apr 2014 06:01:16 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.099\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.099 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id P0TSqhS3bnKP for <notmuch@notmuchmail.org>;\r
+       Wed, 16 Apr 2014 06:01:11 -0700 (PDT)\r
+Received: from mail-pd0-f177.google.com (mail-pd0-f177.google.com\r
+       [209.85.192.177]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 24688431FD2\r
+       for <notmuch@notmuchmail.org>; Wed, 16 Apr 2014 06:00:28 -0700 (PDT)\r
+Received: by mail-pd0-f177.google.com with SMTP id y10so10574801pdj.8\r
+       for <notmuch@notmuchmail.org>; Wed, 16 Apr 2014 06:00:27 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:in-reply-to:references;\r
+       bh=0AkcXmAdIFPgm3MvdxutFQLVbApA31ZpQRxN+c6HaXg=;\r
+       b=TygNZifuO7PAO6hCywKEtnWW2HRW2cyqgLaNA8lrfSd4/LRh32+1AwkxZbe88TLno2\r
+       wPQRjv4EBaUadDfVysZLj0PyL0Y/yF9pmPPCaGwOLKw9fQa/NY3X3snLK4B7yvG8X/wX\r
+       jrGiEwVqxFzx/DLcW57tDQb77hq4Cg3wMChUK72vgfr4K9Gz4uldpbLd80b3j8t+pwMl\r
+       RwVBpANtI6HmMY9C+eBpZiqQlazqL9QyLdyrovJ8DfgWVkZyL8vXwVLLGn5X1+hk0DqX\r
+       WQWP9wTvcNeuMmVhW/yih19lewPkEc42/jxZ2xXTF6P5y5zX64pP/IkdIK/SBAP5vJ1f\r
+       0m0g==\r
+X-Received: by 10.68.143.196 with SMTP id sg4mr8187485pbb.155.1397653227444;\r
+       Wed, 16 Apr 2014 06:00:27 -0700 (PDT)\r
+Received: from localhost (215.42.233.220.static.exetel.com.au.\r
+       [220.233.42.215]) by mx.google.com with ESMTPSA id\r
+       pb7sm111048424pac.10.2014.04.16.06.00.25 for <multiple recipients>\r
+       (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+       Wed, 16 Apr 2014 06:00:26 -0700 (PDT)\r
+From: Peter Wang <novalazy@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 10/10] man: update insert documentation\r
+Date: Wed, 16 Apr 2014 22:59:25 +1000\r
+Message-Id: <1397653165-15620-11-git-send-email-novalazy@gmail.com>\r
+X-Mailer: git-send-email 1.8.4\r
+In-Reply-To: <1397653165-15620-1-git-send-email-novalazy@gmail.com>\r
+References: <1397653165-15620-1-git-send-email-novalazy@gmail.com>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Wed, 16 Apr 2014 13:01:16 -0000\r
+\r
+Add documentation for the insert --must-index option\r
+and failure exit codes.\r
+---\r
+ doc/man1/notmuch-insert.rst | 24 ++++++++++++++++++------\r
+ 1 file changed, 18 insertions(+), 6 deletions(-)\r
+\r
+diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst\r
+index 2be1a7b..02c516b 100644\r
+--- a/doc/man1/notmuch-insert.rst\r
++++ b/doc/man1/notmuch-insert.rst\r
+@@ -38,16 +38,28 @@ Supported options for **insert** include\r
+         does not exist. Otherwise the folder must already exist for mail\r
+         delivery to succeed.\r
+ \r
++    ``--must-index``\r
++        Succeed only if the message is written to disk, added to the\r
++        notmuch database, and tagged (unless a duplicate message).\r
++        Failure to synchronize tags to maildir flags has no effect.\r
++        Without this option, **insert** succeeds as long as the message\r
++        is written to disk.\r
++\r
+ EXIT STATUS\r
+ ===========\r
+ \r
+-This command returns exit status 0 if the message was successfully added\r
+-to the mail directory, even if the message could not be indexed and\r
+-added to the notmuch database. In the latter case, a warning will be\r
+-printed to standard error but the message file will be left on disk.\r
++This command returns exit status 0 on success. On failure, it returns a\r
++non-zero exit status:\r
++\r
++    1\r
++        General failure code.\r
++\r
++    2\r
++        Failed to write the message to disk.\r
+ \r
+-If the message could not be written to disk then a non-zero exit status\r
+-is returned.\r
++    3\r
++        Failed to index or tag the message (unless a duplicate message),\r
++        and ``--must-index`` was specified.\r
+ \r
+ SEE ALSO\r
+ ========\r
+-- \r
+1.8.4\r
+\r