about summary refs log tree commit homepage
path: root/Documentation/public-inbox-v2-format.pod
diff options
context:
space:
mode:
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>2020-12-22 18:18:10 +0100
committerEric Wong <e@80x24.org>2020-12-22 22:56:02 +0000
commit1350f5ab09f72c75ac2cd6c88f6a2b9e198fef55 (patch)
tree66300f05d6ec76efe4176320077f37df4855e928 /Documentation/public-inbox-v2-format.pod
parent2adbbf87748719b422ba08d674ccb35637cb76b5 (diff)
downloadpublic-inbox-1350f5ab09f72c75ac2cd6c88f6a2b9e198fef55.tar.gz
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.
Diffstat (limited to 'Documentation/public-inbox-v2-format.pod')
-rw-r--r--Documentation/public-inbox-v2-format.pod2
1 files changed, 1 insertions, 1 deletions
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