Re: [PATCH rdma-core] Fix bad whatis entries in man pages

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Jun 28, 2018 at 03:26:47PM +0200, Benjamin Drung wrote:
> 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.
>
> This fixes the lintian warning manpage-has-bad-whatis-entry.
>
> Signed-off-by: Benjamin Drung <benjamin.drung@xxxxxxxxxxxxxxxx>
> ---
>  libibverbs/man/ibv_create_counters.3.md | 2 +-
>  libibverbs/man/ibv_read_counters.3.md   | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>

Thanks, applied.

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Photo]     [Yosemite News]     [Yosemite Photos]     [Linux Kernel]     [Linux SCSI]     [XFree86]

  Powered by Linux