Bug #3889

manpage-has-bad-whatis-entry

Added by Dmitry Smirnov over 5 years ago. Updated about 5 years ago.

Status:ClosedStart date:07/25/2015
Priority:LowDue date:
Assignee:Javi Fontan% Done:

0%

Category:Documentation
Target version:Release 4.14
Resolution:fixed Pull request:
Affected Versions:OpenNebula 4.12

Description

Almost all man pages are affected by the following problem (detected by Lintian):

manpage-has-bad-whatis-entry
Each manual page should start with a "NAME" section, which lists the 
name and a brief description of the page separated by "\-". The "NAME"
section is parsed by lexgrog and used to generate a database that's
queried by commands like apropos and whatis. This tag indicates that
lexgrog was unable to parse the NAME section of this manual page.
For manual pages that document multiple programs, functions, files, or 
other things, the part before "\-" should list each separated by a comma
and a space. Each thing listed must not contain spaces; a man page for a
two-part command like "fs listacl" must use something like "fs_listacl"
in the "NAME" section so that it can be parsed by lexgrog.
Refer to the lexgrog(1) manual page, the groff_man(7) manual page, and 
the groff_mdoc(7) manual page for details.

Associated revisions

Revision 68d0dd0a
Added by Javi Fontan about 5 years ago

bug #3889: add command description in man pages

Revision f3d57119
Added by Javi Fontan about 5 years ago

bug #3889: add command description in man pages

History

#1 Updated by Dmitry Smirnov over 5 years ago

I would provide a patch for this problem but what's the point patching generated files? See #3890...

#2 Updated by Ruben S. Montero about 5 years ago

  • Assignee set to Javi Fontan
  • Target version set to Release 4.14

#3 Updated by Javi Fontan about 5 years ago

I've uploaded a new version of 4.14 man pages to branch bug-3889 (https://github.com/OpenNebula/one/tree/bug-3889) and updated the scripts that generate man files.

#4 Updated by Javi Fontan about 5 years ago

  • Status changed from Pending to Closed
  • Resolution set to fixed

Now the format seems to be OK. If any problem is found we can reopen the issue.

#5 Updated by Javi Fontan about 5 years ago

New man pages merged to master.

Also available in: Atom PDF