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

v2 bug: generated manpage has error in metadata #1040

Closed
7 tasks
zhsj opened this issue Jan 14, 2020 · 3 comments · Fixed by #1041
Closed
7 tasks

v2 bug: generated manpage has error in metadata #1040

zhsj opened this issue Jan 14, 2020 · 3 comments · Fixed by #1041

Comments

@zhsj
Copy link
Contributor

zhsj commented Jan 14, 2020

my urfave/cli version is

master

Checklist

  • Are you running the latest v2 release? The list of releases is here.
  • Did you check the manual for your release? The v2 manual is here
  • Did you perform a search about this problem? Here's the Github guide about searching.

Dependency Management

  • My project is using go modules.
  • My project is using vendoring.
  • My project is automatically downloading the latest version.
  • I am unsure of what my dependency management setup is.

Describe the bug

Take the manpage in testdata, man -l testdata/expected-doc-full.man

image

To reproduce

Describe the steps or code required to reproduce the behavior

Observed behavior

What did you see happen immediately after the reproduction steps above?

Expected behavior

What would you have expected to happen immediately after the reproduction steps above?

The manpage is rendered correctly, like most manpages. For example, if you read the manpage of man ls

image

Additional context

Add any other context about the problem here.

If the issue relates to a specific open source Github repo, please link that repo here.

If you can reproduce this issue with a public CI system, please link a failing build here.

Want to fix this yourself?

We'd love to have more contributors on this project! If the fix for this bug is easily explained and very small, free free to create a pull request for it.

Run go version and paste its output here

# paste `go version` output in here

Run go env and paste its output here

# paste `go env` output in here
@saschagrunert
Copy link
Member

Hey @zhsj, this might be an issue with our markdown doc template. The greet(8)() was not reproducible for me right now. Which kind of settings for the app did you use?

@zhsj
Copy link
Contributor Author

zhsj commented Jan 14, 2020

Hey @zhsj, this might be an issue with our markdown doc template. The greet(8)() was not reproducible for me right now. Which kind of settings for the app did you use?

The screenshot is taken from https://github.com/urfave/cli/blob/master/testdata/expected-doc-full.man run command man -l path/to/file

saschagrunert added a commit to saschagrunert/cli that referenced this issue Jan 14, 2020
Closes urfave#1040

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
@saschagrunert
Copy link
Member

Got it, fix is incoming.

saschagrunert added a commit to saschagrunert/cli that referenced this issue Jan 15, 2020
Closes urfave#1040

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants