* [PATCH] doc: clean up manpage description of "notmuch-config list" output
@ 2020-01-10 18:58 Daniel Kahn Gillmor
2020-01-16 10:43 ` David Bremner
0 siblings, 1 reply; 2+ messages in thread
From: Daniel Kahn Gillmor @ 2020-01-10 18:58 UTC (permalink / raw)
To: Notmuch Mail
The escaping in the description of the output of "notmuch-config list"
appears to have been inherited from some previous attempts at
documentation. It leaked out in the actual generated manpage
documentation, where it looks like this:
list Every configuration item is printed to stdout, each on a
separate line of the form:
*section*.\ *item*\ =\ *value*
This simplification cleans up the overescaping.
Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
---
doc/man1/notmuch-config.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 28487079..7347ad31 100644
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -38,7 +38,7 @@ programmatically as described in the SYNOPSIS above.
Every configuration item is printed to stdout, each on a separate
line of the form::
- *section*.\ *item*\ =\ *value*
+ section.item=value
No additional whitespace surrounds the dot or equals sign
characters. In a multiple-value item (a list), the values are
--
2.24.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] doc: clean up manpage description of "notmuch-config list" output
2020-01-10 18:58 [PATCH] doc: clean up manpage description of "notmuch-config list" output Daniel Kahn Gillmor
@ 2020-01-16 10:43 ` David Bremner
0 siblings, 0 replies; 2+ messages in thread
From: David Bremner @ 2020-01-16 10:43 UTC (permalink / raw)
To: Daniel Kahn Gillmor, Notmuch Mail
Daniel Kahn Gillmor <dkg@fifthhorseman.net> writes:
> The escaping in the description of the output of "notmuch-config list"
> appears to have been inherited from some previous attempts at
> documentation. It leaked out in the actual generated manpage
> documentation, where it looks like this:
pushed
d
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-01-16 10:44 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-01-10 18:58 [PATCH] doc: clean up manpage description of "notmuch-config list" output Daniel Kahn Gillmor
2020-01-16 10:43 ` David Bremner
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).