]> git.notmuchmail.org Git - notmuch/commit
notmuch(1): clarify documentation about --option/value separators
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Thu, 7 May 2020 19:26:45 +0000 (15:26 -0400)
committerDavid Bremner <david@tethera.net>
Fri, 8 May 2020 11:58:46 +0000 (08:58 -0300)
commit02a2bf1b256f4eeb8c5e08129a2f0976da2569ce
treef64b00aa3332fd93d2e3aec75dd388962c83e024
parent45cfeb2e557bb4eeb2a9821fa44207eeb6cd335c
notmuch(1): clarify documentation about --option/value separators

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