[PATCH 2/3] man: document insert --must-index

diff --git a/a5/7c09e6c5182b3943f1e4501d804372d9ab3573 b/a5/7c09e6c5182b3943f1e4501d804372d9ab3573
new file mode 100644 (file)
index 0000000..9561e02
--- /dev/null
+++ b/a5/7c09e6c5182b3943f1e4501d804372d9ab3573
@@ -0,0 +1,123 @@
+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 85E5A431FC9\r
+       for <notmuch@notmuchmail.org>; Sat, 20 Jul 2013 17:08:25 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.799\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.799 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_LOW=-0.7] 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 FelO8tbu+6vk for <notmuch@notmuchmail.org>;\r
+       Sat, 20 Jul 2013 17:08:02 -0700 (PDT)\r
+Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com\r
+       [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 9EF35431FBF\r
+       for <notmuch@notmuchmail.org>; Sat, 20 Jul 2013 17:08:02 -0700 (PDT)\r
+Received: by mail-pb0-f53.google.com with SMTP id xb12so5761073pbc.12\r
+       for <notmuch@notmuchmail.org>; Sat, 20 Jul 2013 17:08:02 -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:x-mailer:in-reply-to:references;\r
+       bh=YlKctHy8ZjmwXvT4J62MFzXRJhriyRxWA9KFRxwobx8=;\r
+       b=fKaP+Mc0JSKy7McU3MYge8p+zqsvzhqPdMXLfVzdO+MERuejyLxI89MCRspqvZSDlz\r
+       787xKXXpq/eroAhkSPaxmip/rg3olWGQtWVyvFld4L21lQU3Xyufrf4IUw3B9tmKKsEV\r
+       akpNGYcmSm459c692W4CMpEh6CbypGf3n54XqNMfms65O/tfBiTO7p+Diucwkolelm5m\r
+       nIxGrMSAZL+IG3gfkMkOX2Jlulvsyr+iU841c0/ltUNdjL95r+ZsAVhr0PqSzYysdizy\r
+       KmJsEod27Pi2jrEyYgFyx9z9Ax2eMM6C09OaG7i4T5+P9FjfBpjo5NDMwNJM7yqR1h06\r
+       cDRQ==\r
+X-Received: by 10.68.36.230 with SMTP id t6mr24280459pbj.15.1374365281989;\r
+       Sat, 20 Jul 2013 17:08:01 -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
+       bs3sm27277988pbc.42.2013.07.20.17.07.58 for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sat, 20 Jul 2013 17:08:00 -0700 (PDT)\r
+From: Peter Wang <novalazy@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 2/3] man: document insert --must-index\r
+Date: Sun, 21 Jul 2013 10:07:33 +1000\r
+Message-Id: <1374365254-13227-2-git-send-email-novalazy@gmail.com>\r
+X-Mailer: git-send-email 1.7.12.1\r
+In-Reply-To: <1374365254-13227-1-git-send-email-novalazy@gmail.com>\r
+References: <1374365254-13227-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: Sun, 21 Jul 2013 00:08:25 -0000\r
+\r
+Add documentation for the new option.\r
+---\r
+ man/man1/notmuch-insert.1 | 39 +++++++++++++++++++++++++++++++++------\r
+ 1 file changed, 33 insertions(+), 6 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-insert.1 b/man/man1/notmuch-insert.1\r
+index d5202ac..44c18d8 100644\r
+--- a/man/man1/notmuch-insert.1\r
++++ b/man/man1/notmuch-insert.1\r
+@@ -55,15 +55,42 @@ Otherwise the folder must already exist for mail\r
+ delivery to succeed.\r
+ \r
+ .RE\r
++\r
++.RS 4\r
++.TP 4\r
++.B "--must-index"\r
++\r
++The default behaviour of\r
++.B notmuch insert\r
++is to succeed if the message is added to the mail directory, even if\r
++the message could not be indexed and added to the notmuch database.\r
++In the latter case, a warning will be printed to standard error but\r
++the message file will be left on disk.\r
++\r
++The\r
++.B "--must-index"\r
++option causes\r
++.B notmuch insert\r
++to fail if the message could not be added to the notmuch database,\r
++and the newly-created message file deleted.\r
++\r
++Failure to set tags does not consitute a failure of the overall\r
++command.\r
++\r
++.RE\r
+ .SH EXIT STATUS\r
+ \r
+-This command returns exit status 0 if the message was successfully\r
+-added to the mail directory, even if the message could not be indexed\r
+-and added to the notmuch database.  In the latter case, a warning will\r
+-be printed to standard error but the message file will be left on disk.\r
++This command returns exit status 0 on success.\r
++On failure, it returns a non-zero exit status.\r
+ \r
+-If the message could not be written to disk then a non-zero exit\r
+-status is returned.\r
++.TP\r
++.B 1\r
++Failed to write the message to disk.\r
++.TP\r
++.B 2\r
++Failed to index the message, and\r
++.B "--must-index"\r
++was specified.\r
+ \r
+ .RE\r
+ .SH SEE ALSO\r
+-- \r
+1.7.12.1\r
+\r