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

Manpage of podman should use U+002d (HYPHEN-MINUS) , instead of converting to U+2010 (HYPHEN), to represent hyphen to prevent confusing #21216

Closed
kuanyui opened this issue Jan 10, 2024 · 3 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.

Comments

@kuanyui
Copy link

kuanyui commented Jan 10, 2024

Issue Description

When reading manpages of podman via man podman, user noticed that it's unable to search command options with dashes (e.g. --foobar), but able to search without dashes (e.g. foobar).

Steps to reproduce the issue

Steps to reproduce the issue

  1. man podman
  2. Press /, enter connection to search, found.
  3. Press / again, enter --connection to search, nothing found.

    (This - is U+002d HYPHEN-MINUS, can be entered via a standard keyboard directly.)

  4. Press / again, enter ‐‐connection to search, found.

    (This is U+2010 HYPHEN, can NOT be entered via keyboard directly. please copy & paste this search keyword)

Describe the results you received

(Already described in reproduce steps)

Describe the results you expected

User should be able to search option directly via typing -- on keyboard. And manpage should not use unnecessary non-ASCII characters.

podman info output

N/A

Podman in a container

No

Privileged Or Rootless

None

Upstream Latest Release

N/A (official build doesn't include built manpages)

Additional environment details

  • openSUSE Tumbleweed
  • podman 4.8.2

Additional information

I noticed that the dashes inside the source code of the manpage are normally entered - (U+002d HYPHEN-MINUS):
https://github.com/containers/podman/blob/bed60d951c992c7ab0c6cd57d6d68fed896d47d7/docs/source/markdown/options/hooks-dir.md?plain=1

Should not convert them to U+2010 HYPHEN when generating manapge.

@kuanyui kuanyui added the kind/bug Categorizes issue or PR as related to a bug. label Jan 10, 2024
@kuanyui kuanyui changed the title Manpage of podman should use U+002d (HYPHEN-MINUS) to represent hyphen to prevent confusing Manpage of podman should use U+002d (HYPHEN-MINUS) , instead of converting to U+2010 (HYPHEN), to represent hyphen to prevent confusing Jan 10, 2024
@rhatdan
Copy link
Member

rhatdan commented Jan 10, 2024

@edsantiago any idea what is going on here?

@Luap99
Copy link
Member

Luap99 commented Jan 10, 2024

see https://lwn.net/Articles/947941/ and AFAIK this has been fixed with cpuguy83/go-md2man#105 in go-md2man
The man page on f39 and building from main looks fine for me so I suggest you file this as bug against opensuse as they ar e likely using an older go-md2man.

@Luap99 Luap99 closed this as not planned Won't fix, can't repro, duplicate, stale Jan 10, 2024
@Luap99
Copy link
Member

Luap99 commented Jan 10, 2024

Or I guess my f39 seems to have this problem patched because cpuguy83/go-md2man#101 is still open. Either way I don't think we can address this in podman as we also use the md source to create html and so on so we cannot really change the source files and need a fix in the generator.

@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Apr 12, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/bug Categorizes issue or PR as related to a bug. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.
Projects
None yet
Development

No branches or pull requests

3 participants