From: Mark Walters <markwalters1009@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH v2 4/8] man: clarify search --exclude documentation
Date: Sat, 11 May 2013 20:50:05 +0100 [thread overview]
Message-ID: <1368301809-12532-5-git-send-email-markwalters1009@gmail.com> (raw)
In-Reply-To: <1368301809-12532-1-git-send-email-markwalters1009@gmail.com>
From: Peter Wang <novalazy@gmail.com>
Highlight "excluded messages" as a term with a meaning that
may not be obvious.
Be explicit about the effects of search --exclude=true and
--exclude=false.
---
man/man1/notmuch-search.1 | 15 +++++++++++++--
1 files changed, 13 insertions(+), 2 deletions(-)
diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1
index d3391f8..59e8f34 100644
--- a/man/man1/notmuch-search.1
+++ b/man/man1/notmuch-search.1
@@ -132,8 +132,19 @@ Limit the number of displayed results to N.
.TP 4
.BR \-\-exclude=(true|false|flag)
-Specify whether to omit messages matching search.tag_exclude from the
-search results (the default) or not. The extra option
+A message is called "excluded" if it matches at least one tag in
+search.tag_exclude that does not appear explicitly in the search terms.
+This option specifies whether to omit excluded messages in the search
+process.
+
+The default value,
+.BR true ,
+prevents excluded messages from matching the search terms.
+
+.B false
+allows excluded messages to match search terms and appear in displayed
+results. Excluded messages are still marked in the relevant outputs.
+
.B flag
only has an effect when
.B --output=summary
--
1.7.9.1
next prev parent reply other threads:[~2013-05-11 19:50 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-05-11 19:50 [PATCH v2 0/8] search --exclude=all Mark Walters
2013-05-11 19:50 ` [PATCH v2 1/8] lib: add --exclude=all option Mark Walters
2013-05-11 19:50 ` [PATCH v2 2/8] cli: add --exclude=all option to notmuch-search.c Mark Walters
2013-05-11 19:50 ` [PATCH v2 3/8] test: add tests for search --exclude=all Mark Walters
2013-05-11 19:50 ` Mark Walters [this message]
2013-05-12 10:59 ` [PATCH v2 4/8] man: clarify search --exclude documentation David Bremner
2013-05-11 19:50 ` [PATCH v2 5/8] man: clarify search --exclude=flag Mark Walters
2013-05-11 19:50 ` [PATCH v2 6/8] man: document search --exclude=all Mark Walters
2013-05-11 19:50 ` [PATCH v2 7/8] lib: add NOTMUCH_EXCLUDE_FLAG to notmuch_exclude_t Mark Walters
2013-05-12 11:20 ` David Bremner
2013-05-13 13:53 ` Peter Wang
2013-05-13 15:10 ` [PATCH v3 " Mark Walters
2013-06-19 21:02 ` Mark Walters
2013-06-21 10:59 ` Tomi Ollila
2013-06-21 23:55 ` Peter Wang
2013-06-22 10:10 ` Mark Walters
2013-06-25 6:09 ` David Bremner
2013-05-11 19:50 ` [PATCH v2 8/8] cli: use notmuch_exclude_t in option parser Mark Walters
2013-06-25 6:09 ` David Bremner
2013-05-13 14:20 ` [PATCH v2] cli: clarify correspondence of --exclude to omit_excluded in search Peter Wang
2013-05-14 0:45 ` [PATCH v2 0/8] search --exclude=all David Bremner
-- strict thread matches above, loose matches on Subject: below --
2012-06-20 13:28 [PATCH " Peter Wang
2012-07-22 1:18 ` [PATCH v2 4/8] man: clarify search --exclude documentation Peter Wang
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1368301809-12532-5-git-send-email-markwalters1009@gmail.com \
--to=markwalters1009@gmail.com \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).