From: Peter Wang <novalazy@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH 4/8] man: clarify search --exclude documentation
Date: Wed, 20 Jun 2012 23:29:03 +1000 [thread overview]
Message-ID: <1340198947-29370-5-git-send-email-novalazy@gmail.com> (raw)
In-Reply-To: <1340198947-29370-1-git-send-email-novalazy@gmail.com>
Highlight "excluded messages" as a piece of jargon 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 | 14 ++++++++++++--
1 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1
index 5c72c4b..003b742 100644
--- a/man/man1/notmuch-search.1
+++ b/man/man1/notmuch-search.1
@@ -116,8 +116,18 @@ 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
+Messages matching search.tag_exclude are called "excluded messages".
+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.4.4
next prev parent reply other threads:[~2012-06-20 13:29 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-06-20 13:28 [PATCH 0/8] search --exclude=all Peter Wang
2012-06-20 13:29 ` [PATCH 1/8] lib: add --exclude=all option Peter Wang
2013-05-11 18:07 ` David Bremner
2012-06-20 13:29 ` [PATCH 2/8] cli: add --exclude=all option to notmuch-search.c Peter Wang
2012-06-20 13:29 ` [PATCH 3/8] test: add tests for search --exclude=all Peter Wang
2012-06-20 13:29 ` Peter Wang [this message]
2012-06-20 20:08 ` [PATCH 4/8] man: clarify search --exclude documentation Mark Walters
2012-06-23 2:02 ` Peter Wang
2012-06-23 7:14 ` Mark Walters
2012-06-20 13:29 ` [PATCH 5/8] man: clarify search --exclude=flag Peter Wang
2012-06-20 13:29 ` [PATCH 6/8] man: document search --exclude=all Peter Wang
2012-06-20 13:29 ` [PATCH 7/8] lib: add NOTMUCH_EXCLUDE_FLAG to notmuch_exclude_t Peter Wang
2012-10-19 5:15 ` Ethan Glasser-Camp
2012-10-19 21:23 ` Ethan Glasser-Camp
2012-10-20 10:04 ` Tomi Ollila
2012-10-21 2:04 ` Peter Wang
2012-10-21 12:10 ` Tomi Ollila
2012-10-21 13:03 ` Ethan Glasser-Camp
2012-06-20 13:29 ` [PATCH 8/8] cli: use notmuch_exclude_t in option parser 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=1340198947-29370-5-git-send-email-novalazy@gmail.com \
--to=novalazy@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).