[PATCH] man: add notes about issues with notmuch-count

diff --git a/a9/2379defe74d7df0d63a8220db10f41789c62cc b/a9/2379defe74d7df0d63a8220db10f41789c62cc
new file mode 100644 (file)
index 0000000..2c3ae67
--- /dev/null
+++ b/a9/2379defe74d7df0d63a8220db10f41789c62cc
@@ -0,0 +1,110 @@
+Return-Path: <sshilovsky@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 0D192431FB6\r
+       for <notmuch@notmuchmail.org>; Tue, 14 Oct 2014 07:50:34 -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 3Lx0KuvdZQNP for <notmuch@notmuchmail.org>;\r
+       Tue, 14 Oct 2014 07:50:29 -0700 (PDT)\r
+Received: from mail-lb0-f172.google.com (mail-lb0-f172.google.com\r
+       [209.85.217.172]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 69D4F431FBD\r
+       for <notmuch@notmuchmail.org>; Tue, 14 Oct 2014 07:50:29 -0700 (PDT)\r
+Received: by mail-lb0-f172.google.com with SMTP id b6so8385780lbj.17\r
+       for <notmuch@notmuchmail.org>; Tue, 14 Oct 2014 07:50: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=eAI7N8poDF3PIMrCDz3rVjDG+OyawBHlqYfQzzyavUA=;\r
+       b=tm+ZyPx3Iuvub3iragIRJLOWwZ9bNMB9LdWaqdg71FAZx8IEH7wvQS4NyuTJtNiXO8\r
+       3pzaOtePlbw/1zsq1YJYFwLJr1RMXwV/zDxdtilaSxkXkeON9xze579IgancDlvNO/9q\r
+       jbHYy3jsroFQ4FVRMzTxh/9MgV67hBbAW96tRQokv4R5WHzwQg9/SzAf403D7Wvkfrlr\r
+       Ew0OT9u5NoW2DphxjtpZ0Y4Z6GliDyrxt2wODkzmDxiz5tEWWEWjBX+62F4TQqEr4/5k\r
+       yaz03V+z9pP5DhVmXDTOAvU81k2Y8dqA4MhwLAXj4T7vr7bVUthfUiL3y1Xd++vxb6yq\r
+       6AMA==\r
+X-Received: by 10.112.48.3 with SMTP id h3mr5825852lbn.71.1413298227589;\r
+       Tue, 14 Oct 2014 07:50:27 -0700 (PDT)\r
+Received: from localhost (shpd-178-69-250-75.vologda.ru. [178.69.250.75])\r
+       by mx.google.com with ESMTPSA id w10sm806201lae.24.2014.10.14.07.50.26\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+       Tue, 14 Oct 2014 07:50:26 -0700 (PDT)\r
+From: Sergei Shilovsky <sshilovsky@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] man: add notes about issues with notmuch-count\r
+Date: Tue, 14 Oct 2014 18:48:32 +0400\r
+Message-Id: <1413298112-19912-2-git-send-email-sshilovsky@gmail.com>\r
+X-Mailer: git-send-email 2.1.0\r
+In-Reply-To: <1413298112-19912-1-git-send-email-sshilovsky@gmail.com>\r
+References: <1413298112-19912-1-git-send-email-sshilovsky@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: Tue, 14 Oct 2014 14:50:34 -0000\r
+\r
+1. notmuch count --output=messages outputs estimated number\r
+\r
+2. notmuch count --output=(files|threads) can be slow\r
+---\r
+ doc/man1/notmuch-count.rst | 14 +++++++++-----\r
+ 1 file changed, 9 insertions(+), 5 deletions(-)\r
+\r
+diff --git a/doc/man1/notmuch-count.rst b/doc/man1/notmuch-count.rst\r
+index ca78c18..3bb6981 100644\r
+--- a/doc/man1/notmuch-count.rst\r
++++ b/doc/man1/notmuch-count.rst\r
+@@ -10,7 +10,7 @@ SYNOPSIS\r
+ DESCRIPTION\r
+ ===========\r
+ \r
+-Count messages matching the search terms.\r
++Count (an estimate of) the number of messages matching the search terms.\r
+ \r
+ The number of matching messages (or threads) is output to stdout.\r
+ \r
+@@ -25,16 +25,20 @@ Supported options for **count** include\r
+     ``--output=(messages|threads|files)``\r
+ \r
+         **messages**\r
+-            Output the number of matching messages. This is the default.\r
++            Output an estimate of the number of matching messages. This is the\r
++            default.\r
+ \r
+         **threads**\r
+-            Output the number of matching threads.\r
++            Output the exact number of matching threads. The search is\r
++            performed, so this is a significantly heavier operation than\r
++            ``--output=messages``.\r
+ \r
+         **files**\r
+-            Output the number of files associated with matching\r
++            Output the exact number of files associated with matching\r
+             messages. This may be bigger than the number of matching\r
+             messages due to duplicates (i.e. multiple files having the\r
+-            same message-id).\r
++            same message-id). The search is performed, so this is a\r
++            significantly heavier operation than ``--output=messages``.\r
+ \r
+     ``--exclude=(true|false)``\r
+         Specify whether to omit messages matching search.tag\_exclude\r
+-- \r
+2.1.0\r
+\r