diff options
Diffstat (limited to 'tags/u/useless-whatis-entry.tag')
| -rw-r--r-- | tags/u/useless-whatis-entry.tag | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/tags/u/useless-whatis-entry.tag b/tags/u/useless-whatis-entry.tag new file mode 100644 index 0000000..102cd1e --- /dev/null +++ b/tags/u/useless-whatis-entry.tag @@ -0,0 +1,16 @@ +Tag: useless-whatis-entry +Severity: warning +Check: documentation/manual +Renamed-From: manpage-has-useless-whatis-entry +Explanation: The whatis entry for this manual page (the brief description found + in the NAME section) is of the form: + . + program - manual page for program + . + This conveys no information about what the program is for and is + repetitive. The short description should contain brief information about + what the program is for to aid in searching with apropos and similar + programs. + . + If this manual page was generated by help2man, use the -n option to + provide a more meaningful description. |