a5/7c09e6c5182b3943f1e4501d804372d9ab3573

   1 Return-Path: <novalazy@gmail.com>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 85E5A431FC9\r
   6         for <notmuch@notmuchmail.org>; Sat, 20 Jul 2013 17:08:25 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.799\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
  12         tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
  13         FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  14 Received: from olra.theworths.org ([127.0.0.1])\r
  15         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  16         with ESMTP id FelO8tbu+6vk for <notmuch@notmuchmail.org>;\r
  17         Sat, 20 Jul 2013 17:08:02 -0700 (PDT)\r
  18 Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com\r
  19         [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 9EF35431FBF\r
  22         for <notmuch@notmuchmail.org>; Sat, 20 Jul 2013 17:08:02 -0700 (PDT)\r
  23 Received: by mail-pb0-f53.google.com with SMTP id xb12so5761073pbc.12\r
  24         for <notmuch@notmuchmail.org>; Sat, 20 Jul 2013 17:08:02 -0700 (PDT)\r
  25 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
  26         h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
  27         bh=YlKctHy8ZjmwXvT4J62MFzXRJhriyRxWA9KFRxwobx8=;\r
  28         b=fKaP+Mc0JSKy7McU3MYge8p+zqsvzhqPdMXLfVzdO+MERuejyLxI89MCRspqvZSDlz\r
  29         787xKXXpq/eroAhkSPaxmip/rg3olWGQtWVyvFld4L21lQU3Xyufrf4IUw3B9tmKKsEV\r
  30         akpNGYcmSm459c692W4CMpEh6CbypGf3n54XqNMfms65O/tfBiTO7p+Diucwkolelm5m\r
  31         nIxGrMSAZL+IG3gfkMkOX2Jlulvsyr+iU841c0/ltUNdjL95r+ZsAVhr0PqSzYysdizy\r
  32         KmJsEod27Pi2jrEyYgFyx9z9Ax2eMM6C09OaG7i4T5+P9FjfBpjo5NDMwNJM7yqR1h06\r
  33         cDRQ==\r
  34 X-Received: by 10.68.36.230 with SMTP id t6mr24280459pbj.15.1374365281989;\r
  35         Sat, 20 Jul 2013 17:08:01 -0700 (PDT)\r
  36 Received: from localhost (215.42.233.220.static.exetel.com.au.\r
  37         [220.233.42.215]) by mx.google.com with ESMTPSA id\r
  38         bs3sm27277988pbc.42.2013.07.20.17.07.58 for <multiple recipients>\r
  39         (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
  40         Sat, 20 Jul 2013 17:08:00 -0700 (PDT)\r
  41 From: Peter Wang <novalazy@gmail.com>\r
  42 To: notmuch@notmuchmail.org\r
  43 Subject: [PATCH 2/3] man: document insert --must-index\r
  44 Date: Sun, 21 Jul 2013 10:07:33 +1000\r
  45 Message-Id: <1374365254-13227-2-git-send-email-novalazy@gmail.com>\r
  46 X-Mailer: git-send-email 1.7.12.1\r
  47 In-Reply-To: <1374365254-13227-1-git-send-email-novalazy@gmail.com>\r
  48 References: <1374365254-13227-1-git-send-email-novalazy@gmail.com>\r
  49 X-BeenThere: notmuch@notmuchmail.org\r
  50 X-Mailman-Version: 2.1.13\r
  51 Precedence: list\r
  52 List-Id: "Use and development of the notmuch mail system."\r
  53         <notmuch.notmuchmail.org>\r
  54 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  55         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  56 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  57 List-Post: <mailto:notmuch@notmuchmail.org>\r
  58 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  59 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  60         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  61 X-List-Received-Date: Sun, 21 Jul 2013 00:08:25 -0000\r
  62 \r
  63 Add documentation for the new option.\r
  64 ---\r
  65  man/man1/notmuch-insert.1 | 39 +++++++++++++++++++++++++++++++++------\r
  66  1 file changed, 33 insertions(+), 6 deletions(-)\r
  67 \r
  68 diff --git a/man/man1/notmuch-insert.1 b/man/man1/notmuch-insert.1\r
  69 index d5202ac..44c18d8 100644\r
  70 --- a/man/man1/notmuch-insert.1\r
  71 +++ b/man/man1/notmuch-insert.1\r
  72 @@ -55,15 +55,42 @@ Otherwise the folder must already exist for mail\r
  73  delivery to succeed.\r
  74  \r
  75  .RE\r
  76 +\r
  77 +.RS 4\r
  78 +.TP 4\r
  79 +.B "--must-index"\r
  80 +\r
  81 +The default behaviour of\r
  82 +.B notmuch insert\r
  83 +is to succeed if the message is added to the mail directory, even if\r
  84 +the message could not be indexed and added to the notmuch database.\r
  85 +In the latter case, a warning will be printed to standard error but\r
  86 +the message file will be left on disk.\r
  87 +\r
  88 +The\r
  89 +.B "--must-index"\r
  90 +option causes\r
  91 +.B notmuch insert\r
  92 +to fail if the message could not be added to the notmuch database,\r
  93 +and the newly-created message file deleted.\r
  94 +\r
  95 +Failure to set tags does not consitute a failure of the overall\r
  96 +command.\r
  97 +\r
  98 +.RE\r
  99  .SH EXIT STATUS\r
 100  \r
 101 -This command returns exit status 0 if the message was successfully\r
 102 -added to the mail directory, even if the message could not be indexed\r
 103 -and added to the notmuch database.  In the latter case, a warning will\r
 104 -be printed to standard error but the message file will be left on disk.\r
 105 +This command returns exit status 0 on success.\r
 106 +On failure, it returns a non-zero exit status.\r
 107  \r
 108 -If the message could not be written to disk then a non-zero exit\r
 109 -status is returned.\r
 110 +.TP\r
 111 +.B 1\r
 112 +Failed to write the message to disk.\r
 113 +.TP\r
 114 +.B 2\r
 115 +Failed to index the message, and\r
 116 +.B "--must-index"\r
 117 +was specified.\r
 118  \r
 119  .RE\r
 120  .SH SEE ALSO\r
 121 -- \r
 122 1.7.12.1\r
 123 \r