Re: mdoc(7): CHECKSTYLE

[Alejandro Colomar]

Hi Branden!

On 4/22/23 22:05, G. Branden Robinson wrote:
> 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?

I got some errors from mdoc(7), which were probably due to the LANDMINE
<https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/etc/groff/tmac/checkstyle.tmac>.
Why is that file problematic with mdoc(7)?

Anyway, I thought that I could just remove it, since it's easier to check
with grep(1) if there's anything printed on stderr.  I should have thought
of that before.

You may ask why am I using mdoc(7).  I was just making sure that the Linux
man-pages' build system works with mdoc(7) pages.  So now it's useful for
testing arbitrary manual pages from other projects by just wiping man*/
and copying the pages from other projects into the repo.  Or even more
interestingly, one can simply copy the makefiles to /usr/share/man/ and
go wild.  debbugs might see a sudden burst of issues regarding man pages :-}.

Cheers,
Alex

> 
> Regards,
> Branden

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5

OpenPGP_signature
Description: OpenPGP digital signature