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

Many linting errors on man page. #34

Closed
vext01 opened this issue Nov 13, 2023 · 2 comments
Closed

Many linting errors on man page. #34

vext01 opened this issue Nov 13, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@vext01
Copy link
Contributor

vext01 commented Nov 13, 2023

OpenBSD's mandoc command has a linter for shaking bugs out of man pages.

If you run mandoc -Tlint yash.1, you get lots of linter errors.

Some are style-related, like:

mandoc: yash.1:3289:305: STYLE: input text line longer than 80 bytes: Local variables may ...

but others are proper warnings, like:

mandoc: yash.1:12733:2: WARNING: skipping paragraph macro: sp after SS

I also notice that when you build an OpenBSD package of yash it says:

/usr/local/pobj/yash-2.55/fake-amd64/usr/local/man/ja/man1/yash.1: No one-line description, using filename "yash"

That last one I've seen before and have fixed like this

(I don't know if any of this matters to you, but I thought I'd mention it)

Thanks

@vext01 vext01 added the bug Something isn't working label Nov 13, 2023
@magicant
Copy link
Owner

The man page is auto-generated with AsciiDoc, so there is little that can be done on my side. You might want to report the issue to AsciiDoc developers.

@vext01
Copy link
Contributor Author

vext01 commented Nov 15, 2023

Fair enough. Closing this.

@vext01 vext01 closed this as completed Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants