unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
* [PATCH] public-inbox-v[12]-format.pod: make lexgrog happy
@ 2020-12-22 17:18 Uwe Kleine-König
  2020-12-22 23:01 ` Eric Wong
  0 siblings, 1 reply; 2+ messages in thread
From: Uwe Kleine-König @ 2020-12-22 17:18 UTC (permalink / raw)
  To: meta

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-v1-format.pod | 2 +-
 Documentation/public-inbox-v2-format.pod | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/public-inbox-v1-format.pod b/Documentation/public-inbox-v1-format.pod
index e5b1dd06732e..da19d2c973b4 100644
--- a/Documentation/public-inbox-v1-format.pod
+++ b/Documentation/public-inbox-v1-format.pod
@@ -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
 
diff --git a/Documentation/public-inbox-v2-format.pod b/Documentation/public-inbox-v2-format.pod
index d6282cb4b884..3c89f13e92ff 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
 
-- 
2.29.2


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] public-inbox-v[12]-format.pod: make lexgrog happy
  2020-12-22 17:18 [PATCH] public-inbox-v[12]-format.pod: make lexgrog happy Uwe Kleine-König
@ 2020-12-22 23:01 ` Eric Wong
  0 siblings, 0 replies; 2+ messages in thread
From: Eric Wong @ 2020-12-22 23:01 UTC (permalink / raw)
  To: Uwe Kleine-König; +Cc: meta

Applied and pushed as commit 1350f5ab09f72c75ac2cd6c88f6a2b9e198fef55
Thanks.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2020-12-22 23:01 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-12-22 17:18 [PATCH] public-inbox-v[12]-format.pod: make lexgrog happy Uwe Kleine-König
2020-12-22 23:01 ` Eric Wong

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).