unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: michaeljgruber+grubix+git@gmail.com
To: notmuch@notmuchmail.org
Cc: Michael J Gruber <git@grubix.eu>
Subject: [PATCH] doc: mark `--output=summary` as default
Date: Wed, 30 Nov 2022 14:58:34 +0100	[thread overview]
Message-ID: <63b925a0b2f94193dd55bdb11fc87158452169c2.1669816662.git.git@grubix.eu> (raw)

From: Michael J Gruber <git@grubix.eu>

`notmuch search` behaves differently depending on the output option: It
either outputs information pertaining to all threads with matching
messages (summary, threads) or to all matching messages (messages,
files, tags). The man page refres solely to the former in the main
description.

Help the user by clearly marking `summary` as the default output option.

Signed-off-by: Michael J Gruber <git@grubix.eu>
---
 doc/man1/notmuch-search.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst
index ad305efd..b87737ea 100644
--- a/doc/man1/notmuch-search.rst
+++ b/doc/man1/notmuch-search.rst
@@ -43,7 +43,7 @@ Supported options for **search** include
 
 .. option:: --output=(summary|threads|messages|files|tags)
 
-   summary
+   summary (default)
      Output a summary of each thread with any message matching the
      search terms. The summary includes the thread ID, date, the
      number of messages in the thread (both the number matched and
-- 
2.39.0.rc0.274.g106f0b89d0

             reply	other threads:[~2022-11-30 14:07 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-30 13:58 michaeljgruber+grubix+git [this message]
2022-12-03 13:40 ` [PATCH] doc: mark `--output=summary` as default David Bremner

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=63b925a0b2f94193dd55bdb11fc87158452169c2.1669816662.git.git@grubix.eu \
    --to=michaeljgruber+grubix+git@gmail.com \
    --cc=git@grubix.eu \
    --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).