[Patch v6 14/14] man: try to clarify the folder: and path: vs. --output=files confusion

diff --git a/5d/6c1a4569dd0bd4e6d8ccffd450d30337a5081b b/5d/6c1a4569dd0bd4e6d8ccffd450d30337a5081b
new file mode 100644 (file)
index 0000000..bd45fa0
--- /dev/null
+++ b/5d/6c1a4569dd0bd4e6d8ccffd450d30337a5081b
@@ -0,0 +1,78 @@
+Return-Path: <bremner@tethera.net>\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 2AF12429E2F\r
+       for <notmuch@notmuchmail.org>; Tue, 11 Mar 2014 16:02:40 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       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 RN1MwT-NPWOX for <notmuch@notmuchmail.org>;\r
+       Tue, 11 Mar 2014 16:02:38 -0700 (PDT)\r
+Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C0662429E39\r
+       for <notmuch@notmuchmail.org>; Tue, 11 Mar 2014 16:02:21 -0700 (PDT)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1WNVgi-0001vZ-W6; Tue, 11 Mar 2014 20:02:20 -0300\r
+Received: (nullmailer pid 25867 invoked by uid 1000); Tue, 11 Mar 2014\r
+       23:01:46 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [Patch v6 14/14] man: try to clarify the folder: and path: vs.\r
+       --output=files confusion\r
+Date: Tue, 11 Mar 2014 20:01:40 -0300\r
+Message-Id: <1394578900-25618-15-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.5.3\r
+In-Reply-To: <1394578900-25618-1-git-send-email-david@tethera.net>\r
+References: <1394578900-25618-1-git-send-email-david@tethera.net>\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, 11 Mar 2014 23:02:40 -0000\r
+\r
+From: Jani Nikula <jani@nikula.org>\r
+\r
+---\r
+ doc/man1/notmuch-search.rst | 9 +++++++--\r
+ 1 file changed, 7 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst\r
+index 7ac6c68..90160f2 100644\r
+--- a/doc/man1/notmuch-search.rst\r
++++ b/doc/man1/notmuch-search.rst\r
+@@ -64,8 +64,13 @@ Supported options for **search** include\r
+             (--format=json), or as an S-Expression list (--format=sexp).\r
+ \r
+             Note that each message may have multiple filenames\r
+-            associated with it. All of them are included in the output,\r
+-            unless limited with the --duplicate=N option.\r
++            associated with it. All of them are included in the output\r
++            (unless limited with the --duplicate=N option). This may\r
++            be particularly confusing for **folder:** or **path:**\r
++            searches in a specified directory, as the messages may\r
++            have duplicates in other directories that are included in\r
++            the output, although these files alone would not match the\r
++            search.\r
+ \r
+         **tags**\r
+             Output all tags that appear on any message matching the\r
+-- \r
+1.8.5.3\r
+\r