[PATCH] doc: clean up manpage description of "notmuch-config list" output

classic Classic list List threaded Threaded
2 messages Options
Daniel Kahn Gillmor Daniel Kahn Gillmor
Reply | Threaded
Open this post in threaded view
|

[PATCH] doc: clean up manpage description of "notmuch-config list" output

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 <[hidden email]>
---
 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

_______________________________________________
notmuch mailing list
[hidden email]
https://notmuchmail.org/mailman/listinfo/notmuch
David Bremner-2 David Bremner-2
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] doc: clean up manpage description of "notmuch-config list" output

Daniel Kahn Gillmor <[hidden email]> 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
_______________________________________________
notmuch mailing list
[hidden email]
https://notmuchmail.org/mailman/listinfo/notmuch