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

"G. Branden Robinson" <[email protected]> Sun, 28 Dec 2025 16:36:15 -0600

Newsgroups	gmane.comp.gnu.findutils.bugs
Message-ID	<20251228223615.ioh7uuzgax643ngm@illithid>

Hi Bernhard,

At 2025-12-28T23:26:11+0100, Bernhard Voelker wrote:
> 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?

I would leave it and ignore the error, unless you want to adopt the
groff man(7) SY/YS extension macros.  The synopsis won't look as good or
traditional if you use an ordinary paragraphing macro (P, LP, PP) there.

I've un-deprecated the `HP` macro for the forthcoming groff 1.24.0
release.

commit d483834af930eeec2cc9f77441af5d581fe18c50
Author: G. Branden Robinson <[email protected]>
Date:   Tue Jul 30 22:02:58 2024 -0500

    tmac/an.tmac: Silence `HP` deprecation warning.

    * tmac/an.tmac (HP): The `mS` extension register has changed its meaning
      (commit f680c55d38, 13 June) such that it is no longer a reliable
      indicator of whether the deprecation warning for this macro should be
      suppressed, so stop suppressing a deprecation warning based on its
      value.  In fact, stop issuing the deprecation warning altogether.
      (See <https://lists.gnu.org/archive/html/bug-ncurses/2024-04/
      msg00027.html>.)

> Likewise here:
[...]
>   an.tmac:./locate.1:18: style: use of deprecated macro: .HP

Yup, that's the same issue.

I think `HP` is valuable for man pages that want to be portable to
legacy Unix systems, and which might be nervous about defining
page-local macros.  (Both groff and mandoc(1) support `SY` and `YS`.)

Regards,
Branden

signature.asc (application/pgp-signature, 833 B)