]> Sergey Matveev's repositories - public-inbox.git/commitdiff
public-inbox-v[12]-format.pod: make lexgrog happy
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Tue, 22 Dec 2020 17:18:10 +0000 (18:18 +0100)
committerEric Wong <e@80x24.org>
Sat, 26 Dec 2020 20:20:13 +0000 (20:20 +0000)
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.

(cherry picked from commit 1350f5ab09f72c75ac2cd6c88f6a2b9e198fef55)

Documentation/public-inbox-v1-format.pod
Documentation/public-inbox-v2-format.pod

index e5b1dd06732ec323573dea7f10167006aedf16ac..da19d2c973b4684a2b466d6bceb81e986affdade 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-public-inbox v1 git repository and tree description (aka "ssoma")
+public-inbox-v1-format - git repository and tree description (aka "ssoma")
 
 =head1 DESCRIPTION
 
index d6282cb4b884b783ed939307f7be2ff3a7bf2e8b..3c89f13e92ff899499545e01a4c6256ecd40db5d 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-public-inbox v2 format description
+public-inbox-v2-format - structure of public inbox v2 archives
 
 =head1 DESCRIPTION