Re: mdoc(7): CHECKSTYLE

[G. Branden Robinson]

Hi Alex,

At 2023-04-22T19:46:54+0200, Alejandro Colomar wrote:
> Is CHECKSTYLE compatible with mdoc(7) pages?

It's not _in_compatible.  mdoc(7) has no support for this register and
does not check for it, but setting it shouldn't break anything.

On the other hand, mdoc(7) is already fairly chatty with diagnostics
(though I mean to revise their format one of these days), and the
package is sufficiently finicky that it already warns about a lot of the
same things that CHECKSTYLE enables in man(7).

.    tm mdoc warning: .Dd directive expects an argument (#\n[.c])

.    tm mdoc warning: .Dt directive expects one or more arguments \
(#\n[.c])

.        tm mdoc warning: .Os: Unknown BSD version '\$2' (#\n[.c])

[many more along these lines]

.    tm mdoc warning: A .Bl directive has no matching .El (#\n[.c])

.    tm mdoc warning: A .Bd directive has no matching .Ed (#\n[.c])

.    tm mdoc warning: A .Bf directive has no matching .Ef (#\n[.c])

...and so forth.

Why do you ask?

Regards,
Branden

signature.asc
Description: PGP signature