Re: [PATCH 08/42] doc: improve formatting of command synopses (1/2)

On 12/28/25 23:26, Bernhard Voelker wrote:
> On 11/19/25 04:45, G. Branden Robinson wrote:
>> diff --git a/find/find.1 b/find/find.1
>> [...]
>>    .SH SYNOPSIS
>> +.HP
> 
> This triggers a 'make check' error:
> 
>     env GROFF=groff ../build-aux/man-lint.sh . find.1
>     check_manpages_format_without_error_messages  (         find.1): OK
>     check_manpages_with_groff_checkstyle_2        (         find.1): FAILED
>     an.tmac:./find.1:23: style: use of deprecated macro: .HP
>     make[3]: *** [Makefile:3112: findutils-check-manpages] Error 1
> 
> Should we replace .HP by a simple .P?
 > Or better just remove it?

According to groff_man_style(7), the better replacement seems to be .TP,
which also caters better for the hanging indentation of the lines
following ...

>> diff --git a/locate/locate.1 b/locate/locate.1
>> [...]
>> +.HP
> 
> Likewise here:
> 
>     env GROFF=groff ../build-aux/man-lint.sh . locate.1 updatedb.1 locatedb.5
>     check_manpages_format_without_error_messages  (       locate.1): OK
>     check_manpages_format_without_error_messages  (     updatedb.1): OK
>     check_manpages_format_without_error_messages  (     locatedb.5): OK
>     check_manpages_with_groff_checkstyle_2        (       locate.1): FAILED
>     an.tmac:./locate.1:18: style: use of deprecated macro: .HP
>     make[3]: *** [Makefile:3287: findutils-check-manpages] Error 1
>     make[3]: Target 'check-local' not remade because of errors.

... which matters at least here in locate.1.

Thanks & have a nice day,
Berny