8000 Replace more escapes with quotes in man parser by ysthakur · Pull Request #9961 · fish-shell/fish-shell · GitHub
[go: up one dir, main page]

Skip to content

Replace more escapes with quotes in man parser#9961

Merged
faho merged 2 commits intofish-shell:masterfrom
ysthakur:master-1
Aug 19, 2023
Merged

Replace more escapes with quotes in man parser#9961
faho merged 2 commits intofish-shell:masterfrom
ysthakur:master-1

Conversation

@ysthakur
Copy link
Contributor
@ysthakur ysthakur commented Aug 17, 2023

Description

Similar to #7086, which is about \(cq. At least one man page (df) uses \(aq, so this PR replaces those with single quotes. I haven't found any examples other than df, though.

I don't understand roff, but looking at the GNU Troff manual, dq, lq, oq, and rq may also have to be replaced with quotes, in addition to cq and aq. dq is a neutral double quote. lq seems to be used for left double quotes and rq for right double quotes, but I assume both can safely be replaced with neutral double quotes. I have no idea what oq is.

TODOs:

  • Changes to fish usage are reflected in user documentation/manpages. <- Is this necessary?
  • Tests have been added for regressions fixed
  • User-visible changes noted in CHANGELOG.rst <- This change isn't particularly user-visible, right?
  • Try to find man pages that use dq, lq, oq, or rq and, if they exist, add them to this PR?

@faho
Copy link
Member
faho commented Aug 18, 2023

Isn't roff lovely?

Try to find man pages that use dq, lq, oq, or rq and, if they exist, add them to this PR?

I can find

  • dq in find and a bunch of others: find . -path "./sr*sc"

  • lq/rq pairs a bunch in git's pages and e.g. strace: “\n” for a newline

  • oq/cq pairs in gnupg: ‘ROOT/home’ for the GnuPG

So the first and second would be double quotes, the third single-quotes.


RE your TODO comments: These are all fine. We can add it to the CHANGELOG if we decide before a release.

@ysthakur
Copy link
Contributor Author

Great, I added those 4 in too.

@ysthakur ysthakur changed the title Replace \(aq with "'" in man parser Replace more escapes with quotes in man parser Aug 18, 2023
@faho faho added this to the fish 3.7.0 milestone Aug 19, 2023
@faho faho merged commit 0f19d71 into fish-shell:master Aug 19, 2023
@faho
Copy link
Member
faho commented Aug 19, 2023

Merged, thanks!

@ysthakur ysthakur deleted the master-1 branch August 19, 2023 15:24
faho pushed a commit that referenced this pull request Oct 6, 2023
* Replace \(aq with "'" in man parser

* Also replace oq, dq, lq, and rq

(cherry picked from commit 0f19d71)
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

0