man: fix some single-quoted strings #2828
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Commit 721aadc ("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. Fixes: 5e2b7d5 ("mu-query.7: update documentation") Signed-off-by: Jeremy Sowden <[email protected]>
Otherwise:
(with the \040 specifying a space in the regular expression, and and extra '\' to escape it)
is rendered as:
(with the $ 40 specifying a space in the regular expression, and and extra `$´ to escape it)
Fixes: 5e2b7d5 ("mu-query.7: update documentation")
Signed-off-by: Jeremy Sowden <[email protected]>
|
Just noticed another problem, which is fixed by the second commit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit 721aadc ("man: change quoting style") replaced single-quoted strings of the form:
with:
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):
which results in the following warning:
and the omission of that line from the rendered paragraph:
Use back-ticks for the opening quotes.
Fixes: 5e2b7d5 ("mu-query.7: update documentation")