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