From e01f2f837bc2ef5189845e88cf77e95621885e0b Mon Sep 17 00:00:00 2001 From: Peter Wang Date: Wed, 20 Jun 2012 23:29:03 +1000 Subject: [PATCH] [PATCH 4/8] man: clarify search --exclude documentation --- 0f/1163778c1d2780914cd0baa844b6eea746dfd8 | 99 +++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 0f/1163778c1d2780914cd0baa844b6eea746dfd8 diff --git a/0f/1163778c1d2780914cd0baa844b6eea746dfd8 b/0f/1163778c1d2780914cd0baa844b6eea746dfd8 new file mode 100644 index 000000000..44ac24c69 --- /dev/null +++ b/0f/1163778c1d2780914cd0baa844b6eea746dfd8 @@ -0,0 +1,99 @@ +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 12F28431FD4 + for ; Wed, 20 Jun 2012 06:29:54 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.799 +X-Spam-Level: +X-Spam-Status: No, score=-0.799 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_LOW=-0.7] 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 zY76t7m2Q9Fs for ; + Wed, 20 Jun 2012 06:29:53 -0700 (PDT) +Received: from mail-pz0-f53.google.com (mail-pz0-f53.google.com + [209.85.210.53]) (using TLSv1 with cipher RC4-MD5 (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id D6F26431FC0 + for ; Wed, 20 Jun 2012 06:29:49 -0700 (PDT) +Received: by mail-pz0-f53.google.com with SMTP id g9so12291942dad.26 + for ; Wed, 20 Jun 2012 06:29:49 -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:x-mailer:in-reply-to:references; + bh=TTJhlYdPM1MqjSiviwqFAiBru8irZ+2C0XT4xWG2yzc=; + b=oEDufKv2YslXwezsCTJ+n47mvxnrGAzy6gJ1jZo0SpgnGrWF17uwX+sEg2KoAWhm7n + 4PbnubY5Kin7VSDbNr/ebEMXwNgqQ5Ld+Fy1C7kOENREnhORbg9A5yj9qzrIdmZdJDQM + b7rmsPFBWwYD2KsyXnpP42b//1mL1xV4TpTOSmFZmTTOIkisYeAlP3hq6AbIlJqFGb7O + i5XSKHrAaLvw2J6QEAYVChcpcezFj6OaAUZLMUHLoYrwZcUyqGE7PWpaSnK9kmEXTS4D + 80B4c8LGS4PR9R4yGn8YcE5i+t1Wy0M7poaR7wERhirYQr8+E+rUA7PFD3UMRBMB6GTo + mnMA== +Received: by 10.68.219.166 with SMTP id pp6mr76233599pbc.35.1340198989738; + Wed, 20 Jun 2012 06:29:49 -0700 (PDT) +Received: from localhost (215.42.233.220.static.exetel.com.au. + [220.233.42.215]) + by mx.google.com with ESMTPS id tk1sm31954773pbc.8.2012.06.20.06.29.47 + (version=TLSv1/SSLv3 cipher=OTHER); + Wed, 20 Jun 2012 06:29:48 -0700 (PDT) +From: Peter Wang +To: notmuch@notmuchmail.org +Subject: [PATCH 4/8] man: clarify search --exclude documentation +Date: Wed, 20 Jun 2012 23:29:03 +1000 +Message-Id: <1340198947-29370-5-git-send-email-novalazy@gmail.com> +X-Mailer: git-send-email 1.7.4.4 +In-Reply-To: <1340198947-29370-1-git-send-email-novalazy@gmail.com> +References: <1340198947-29370-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, 20 Jun 2012 13:29:54 -0000 + +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 + -- 2.26.2