44/3c5027dd2edcf5f9b85f72c6fef2df1df73044

   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 90B63429E31\r
   6         for <notmuch@notmuchmail.org>; Wed, 16 Apr 2014 06:01:16 -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.099\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.099 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_NONE=-0.0001] 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 P0TSqhS3bnKP for <notmuch@notmuchmail.org>;\r
  17         Wed, 16 Apr 2014 06:01:11 -0700 (PDT)\r
  18 Received: from mail-pd0-f177.google.com (mail-pd0-f177.google.com\r
  19         [209.85.192.177]) (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 24688431FD2\r
  22         for <notmuch@notmuchmail.org>; Wed, 16 Apr 2014 06:00:28 -0700 (PDT)\r
  23 Received: by mail-pd0-f177.google.com with SMTP id y10so10574801pdj.8\r
  24         for <notmuch@notmuchmail.org>; Wed, 16 Apr 2014 06:00:27 -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:in-reply-to:references;\r
  27         bh=0AkcXmAdIFPgm3MvdxutFQLVbApA31ZpQRxN+c6HaXg=;\r
  28         b=TygNZifuO7PAO6hCywKEtnWW2HRW2cyqgLaNA8lrfSd4/LRh32+1AwkxZbe88TLno2\r
  29         wPQRjv4EBaUadDfVysZLj0PyL0Y/yF9pmPPCaGwOLKw9fQa/NY3X3snLK4B7yvG8X/wX\r
  30         jrGiEwVqxFzx/DLcW57tDQb77hq4Cg3wMChUK72vgfr4K9Gz4uldpbLd80b3j8t+pwMl\r
  31         RwVBpANtI6HmMY9C+eBpZiqQlazqL9QyLdyrovJ8DfgWVkZyL8vXwVLLGn5X1+hk0DqX\r
  32         WQWP9wTvcNeuMmVhW/yih19lewPkEc42/jxZ2xXTF6P5y5zX64pP/IkdIK/SBAP5vJ1f\r
  33         0m0g==\r
  34 X-Received: by 10.68.143.196 with SMTP id sg4mr8187485pbb.155.1397653227444;\r
  35         Wed, 16 Apr 2014 06:00:27 -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         pb7sm111048424pac.10.2014.04.16.06.00.25 for <multiple recipients>\r
  39         (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
  40         Wed, 16 Apr 2014 06:00:26 -0700 (PDT)\r
  41 From: Peter Wang <novalazy@gmail.com>\r
  42 To: notmuch@notmuchmail.org\r
  43 Subject: [PATCH v2 10/10] man: update insert documentation\r
  44 Date: Wed, 16 Apr 2014 22:59:25 +1000\r
  45 Message-Id: <1397653165-15620-11-git-send-email-novalazy@gmail.com>\r
  46 X-Mailer: git-send-email 1.8.4\r
  47 In-Reply-To: <1397653165-15620-1-git-send-email-novalazy@gmail.com>\r
  48 References: <1397653165-15620-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: Wed, 16 Apr 2014 13:01:16 -0000\r
  62 \r
  63 Add documentation for the insert --must-index option\r
  64 and failure exit codes.\r
  65 ---\r
  66  doc/man1/notmuch-insert.rst | 24 ++++++++++++++++++------\r
  67  1 file changed, 18 insertions(+), 6 deletions(-)\r
  68 \r
  69 diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst\r
  70 index 2be1a7b..02c516b 100644\r
  71 --- a/doc/man1/notmuch-insert.rst\r
  72 +++ b/doc/man1/notmuch-insert.rst\r
  73 @@ -38,16 +38,28 @@ Supported options for **insert** include\r
  74          does not exist. Otherwise the folder must already exist for mail\r
  75          delivery to succeed.\r
  76  \r
  77 +    ``--must-index``\r
  78 +        Succeed only if the message is written to disk, added to the\r
  79 +        notmuch database, and tagged (unless a duplicate message).\r
  80 +        Failure to synchronize tags to maildir flags has no effect.\r
  81 +        Without this option, **insert** succeeds as long as the message\r
  82 +        is written to disk.\r
  83 +\r
  84  EXIT STATUS\r
  85  ===========\r
  86  \r
  87 -This command returns exit status 0 if the message was successfully added\r
  88 -to the mail directory, even if the message could not be indexed and\r
  89 -added to the notmuch database. In the latter case, a warning will be\r
  90 -printed to standard error but the message file will be left on disk.\r
  91 +This command returns exit status 0 on success. On failure, it returns a\r
  92 +non-zero exit status:\r
  93 +\r
  94 +    1\r
  95 +        General failure code.\r
  96 +\r
  97 +    2\r
  98 +        Failed to write the message to disk.\r
  99  \r
 100 -If the message could not be written to disk then a non-zero exit status\r
 101 -is returned.\r
 102 +    3\r
 103 +        Failed to index or tag the message (unless a duplicate message),\r
 104 +        and ``--must-index`` was specified.\r
 105  \r
 106  SEE ALSO\r
 107  ========\r
 108 -- \r
 109 1.8.4\r
 110 \r