bpf-helpers.7: .TH line is... meh (was: [PATCH] bpf_doc.py: Use SPDX-License-Identifier)

Alejandro Colomar <alx.manpages@xxxxxxxxx> · Tue, 2 Aug 2022 00:13:01 +0200

Hi Daniel,

On 7/22/22 00:50, patchwork-bot+netdevbpf@xxxxxxxxxx wrote:
Hello:

This patch was applied to bpf/bpf-next.git (master)
by Daniel Borkmann <daniel@xxxxxxxxxxxxx>:

On Thu, 21 Jul 2022 13:08:22 +0200 you wrote:
The Linux man-pages project now uses SPDX tags,
instead of the full license text.

Signed-off-by: Alejandro Colomar <alx.manpages@xxxxxxxxx>
---
  scripts/bpf_doc.py | 22 +---------------------
  1 file changed, 1 insertion(+), 21 deletions(-)

Here is the summary with links:
   - bpf_doc.py: Use SPDX-License-Identifier
     https://git.kernel.org/bpf/bpf-next/c/5cb62b7598f2

You are awesome, thank you!

Oh, what a nice bot :)

I've been running a linter on the man-pages, and had this triggered from 
bpf-helpers.7:

[
$ make lint V=1
LINT (groff)	tmp/lint/man7/bpf-helpers.7.lint-man.groff.touch
groff -man -t -M ./etc/groff/tmac -m checkstyle -rCHECKSTYLE=3 -ww  -z 
man7/bpf-helpers.7
an.tmac:man7/bpf-helpers.7:3: style: .TH missing third argument; suggest 
document modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:man7/bpf-helpers.7:3: style: .TH missing fourth argument; 
suggest package/project name and version (e.g., "groff 1.23.0")
an.tmac:man7/bpf-helpers.7:3: style: .TH missing fifth argument and 
second argument '7' not a recognized manual section; specify volume title
found style problems; aborting
make: *** [lib/lint-man.mk:49: 
tmp/lint/man7/bpf-helpers.7.lint-man.groff.touch] Error 1

]

See what a normal .TH line looks like, and what bpf-helpers.7 has:

[
$ grep ^.TH man2/bpf.2
.TH BPF 2 2021-08-27 "Linux" "Linux Programmer's Manual"
$ grep ^.TH man7/bpf-helpers.7
.TH BPF-HELPERS 7 "" "" ""
]

I don't know if you can fix that, or if it's a limitation of the 
generator?  I can live with it, but it would be nice if it could be 
fixed.  It provides the headers and footers of the manual page.

Cheers,

Alex

--
Alejandro Colomar
<http://www.alejandro-colomar.es/>
Attachment:
OpenPGP_signature

Description: OpenPGP digital signature