search

magicant / yash

Yet another shell
http://magicant.github.io/yash/
GNU General Public License v2.0
301 stars 28 forks source link

Many linting errors on man page. #34

Closed vext01 closed 8 months ago

vext01 commented 8 months ago

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

magicant commented 8 months ago

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 commented 8 months ago

Fair enough. Closing this.