From 1350f5ab09f72c75ac2cd6c88f6a2b9e198fef55 Mon Sep 17 00:00:00 2001 From: Uwe Kleine-König Date: Tue, 22 Dec 2020 18:18:10 +0100 Subject: public-inbox-v[12]-format.pod: make lexgrog happy The Debian package linter (lintian) emits the following warning: W: bad-whatis-entry N: N: A manual page should start with a NAME section, which lists the N: program name and a brief description. The NAME section is used to N: generate a database that can be queried by commands like apropos and N: whatis. You are seeing this tag because lexgrog was unable to parse N: the NAME section. N: N: Manual pages for multiple programs, functions, or files should list N: each separated by a comma and a space, followed by \- and a common N: description. N: N: Listed items may not contain any spaces. A manual page for a two-level N: command such as fs listacl must look like fs_listacl so the list is N: read correctly. N: N: Refer to the lexgrog(1) manual page, the groff_man(7) manual page, and N: the groff_mdoc(7) manual page for details. N: N: Severity: warning N: N: Check: documentation/manual N: N: Renamed from: manpage-has-bad-whatis-entry N: for public-inbox-v1-format and public-inbox-v2-format. Adapt the descriptions to make lexgrog and so lintian happy. --- Documentation/public-inbox-v2-format.pod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/public-inbox-v2-format.pod') diff --git a/Documentation/public-inbox-v2-format.pod b/Documentation/public-inbox-v2-format.pod index d6282cb4..3c89f13e 100644 --- a/Documentation/public-inbox-v2-format.pod +++ b/Documentation/public-inbox-v2-format.pod @@ -2,7 +2,7 @@ =head1 NAME -public-inbox v2 format description +public-inbox-v2-format - structure of public inbox v2 archives =head1 DESCRIPTION -- cgit v1.2.3-24-ge0c7