unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
To: Notmuch Mail <notmuch@notmuchmail.org>
Subject: [PATCH] notmuch(1): clarify documentation about --option/value separators
Date: Thu,  7 May 2020 15:26:45 -0400	[thread overview]
Message-ID: <20200507192645.124644-1-dkg@fifthhorseman.net> (raw)
In-Reply-To: <87o8r2tex4.fsf@wondoo.home.cworth.org>

id:CA+Tk8fzRiqxWpd=r8=DRvEewNZXUZgD7MKyRLB1A=R-LxxGEZw@mail.gmail.com
started a thread of discussion that showed that the cli's current
idiosyncrasies around dealing with boolean options were not
understandable.

This attempts to improve the documentation at least (actual changes to
the API might be better, but have not reached consensus).

Note that no one in the discussion thread identified any other
(non-boolean) command-line options that cannot use space as a
separator.  If such an option is identified (or introduced in the
future), it should be added explicitly to this part of the manual.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
---
 doc/man1/notmuch.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index d2cd8da5..3dcc646c 100644
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -128,9 +128,9 @@ OPTION SYNTAX
 -------------
 
 All options accepting an argument can be used with '=' or ':' as a
-separator. For the cases where it's not ambiguous (in particular
-excluding boolean options), a space can also be used. The following
-are all equivalent:
+separator. Except for boolean options (wihch would be ambiguous), a
+space can also be used as a separator. The following are all
+equivalent:
 
 ::
 
-- 
2.26.2

  reply	other threads:[~2020-05-07 19:27 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-24 12:53 Inconsistencies in handling command flags: `--flag=value` different than `--flag value` Ciprian Dorin Craciun
2020-04-27 17:53 ` David Bremner
2020-04-27 18:02   ` Daniel Kahn Gillmor
2020-04-27 18:20     ` Tomi Ollila
2020-04-27 19:21       ` Ciprian Dorin Craciun
2020-04-29  2:16         ` Daniel Kahn Gillmor
2020-04-29 14:18           ` Tomi Ollila
2020-04-29 15:39             ` David Bremner
2020-04-29 15:45               ` Jameson Graef Rollins
2020-04-29 16:28                 ` David Bremner
2020-05-05 18:28                 ` Carl Worth
2020-05-07 19:26                   ` Daniel Kahn Gillmor [this message]
2020-05-07 23:40                     ` [PATCH] notmuch(1): clarify documentation about --option/value separators Carl Worth
2020-05-08 12:01                       ` David Bremner
2020-05-08 16:06                       ` Daniel Kahn Gillmor
2020-04-29 15:59               ` Inconsistencies in handling command flags: `--flag=value` different than `--flag value` Ciprian Dorin Craciun
2020-04-29 16:07                 ` Jameson Graef Rollins
2020-04-29 15:33           ` Jameson Graef Rollins
2020-04-30 16:59             ` Daniel Kahn Gillmor

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=20200507192645.124644-1-dkg@fifthhorseman.net \
    --to=dkg@fifthhorseman.net \
    --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).