fix some single-quoted strings in man-page
authorJeremy Sowden <jeremy@azazel.net>
Mon, 10 Mar 2025 22:07:50 +0000 (22:07 +0000)
committerJeremy Sowden <azazel@debian.org>
Mon, 10 Mar 2025 22:07:50 +0000 (22:07 +0000)
Last-Update: 2025-03-10
Forwarded: https://github.com/djcb/mu/pull/2828

The upstream commit 721aadc140f2 ("man: change quoting style") replaced
single-quoted strings of the form:

  'lorem ipsum'

with:

  `lorem ipsum'

to prevent the possibility of single quotes appearing at the beginning of
lines, because these will be misinterpreted by troff.  However, changes to the
man-page sources in 1.12.9 reintroduced some of these, including one which does
appear at the beginning of a line in mu-query(7):

  '"', '*', '(' and ')'. The details are shell-specific. In case of doubt, the

which results in the following warning:

  troff:<standard input>:25: warning: macro '"',' not defined

and the omission of that line from the rendered paragraph:

  NOTE:  if  you  use  queries on the command-line (say, for mu find), you
  need to quote any characters that would otherwise be interpreted by  the
  shell, such as *--analyze option can be useful.

Use back-ticks for the opening quotes.

Gbp-Pq: Name fix-single-quotes-in-man-pages.patch

man/mu-query.7.org

index 694a56ebd428574b96e63270c99d5c3b62dae6fd..d9c380ebeb57b0f376857e2d10f96935c1976b7c 100644 (file)
@@ -23,7 +23,7 @@ See the *ANALYZING QUERIES* section for further details.
 
 *NOTE:* if you use queries on the command-line (say, for *mu find*), you need to
 quote any characters that would otherwise be interpreted by the shell, such as
-'"', '*', '(' and ')'. The details are shell-specific. In case of doubt, the
+`"', `*', `(' and `)'. The details are shell-specific. In case of doubt, the
 *--analyze* option can be useful.
 
 * TERMS
@@ -136,7 +136,7 @@ $ mu find "hello*"
 #+end_example
 
 Quoting the "hello*" is recommended; some shells (but not all) would otherwise
-expand the '*' to all files in the current directory.
+expand the `*' to all files in the current directory.
 
 * REGULAR EXPRESSIONS
 
@@ -165,7 +165,7 @@ whitespace, so the search for a message with subject "hello world", you can writ
 #+begin_example
 mu find 'subject:/hello\\040world/'
 #+end_example
-(with the \040 specifying a space in the regular expression, and and extra '\'
+(with the \040 specifying a space in the regular expression, and and extra `\'
 to escape it). In many cases,
 #+begin_example
 mu find 'subject:/hello.world/'