Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: man: fix wrong escapes #6474

Merged
merged 1 commit into from
Sep 13, 2024
Merged

Conversation

kmk3
Copy link
Collaborator

@kmk3 kmk3 commented Sep 12, 2024

Remove extranous escape characters and fix bold escaping.

Command used to check for unusual escape sequences:

$ git grep -E -e '\\f[^BR]' -e '\\[^ "\f-]' -- src/man/*.in

With this, the only escape sequences used are:

$ git grep -E -ho -e '\\-' -e '\\[^-][^ ]?' -- src/man/*.in |
  LC_ALL=C sort | uniq -c
      9 \"
      1 \&.
   1194 \-
     23 \\
    507 \fB
    127 \fR

Related commits:

This is a follow-up to #6472.

Kind of relates to #5903.

@kmk3 kmk3 added the documentation Issues and pull requests related to the documentation label Sep 12, 2024
Remove extranous escape characters and fix bold escaping.

Command used to check for unusual escape sequences:

    $ git grep -E -e '\\f[^BR]' -e '\\[^ "\f-]' -- src/man/*.in

With this, the only escape sequences used are:

    $ git grep -E -ho -e '\\-' -e '\\[^-][^ ]?' -- src/man/*.in |
      LC_ALL=C sort | uniq -c
          9 \"
          1 \&.
       1194 \-
         23 \\
        507 \fB
        127 \fR

Related commits:

* 1379851 ("Baseline firejail 0.9.28", 2015-08-08)
* 1684c9e ("Fixes for man firejail (netblue30#2628)", 2019-03-29)
* 7352501 ("Clarify that file globbing occurs only at start",
  2020-04-11) / PR netblue30#3347
* f54ee53 ("man text for --include command", 2021-03-05).

This is a follow-up to netblue30#6472.

Kind of relates to netblue30#5903.
@kmk3 kmk3 merged commit ef5ca49 into netblue30:master Sep 13, 2024
2 checks passed
@kmk3 kmk3 deleted the docs-man-fix-escapes branch September 13, 2024 07:10
kmk3 added a commit that referenced this pull request Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues and pull requests related to the documentation
Projects
Status: Done (on RELNOTES)
Development

Successfully merging this pull request may close these issues.

1 participant