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

Bug#643735: lintian: Add check for manual page to verify TH matches FILENAME.N



On 2011-10-12 13:27, Niels Thykier wrote:
| On 2011-09-29 07:11, Jari Aalto wrote:
| > Package: lintian
| > Version: 2.5.3
| > Severity: wishlist
| > 
| > An example. Binary name /usr/bin/xsnap-ocr and manpage in
| > .../man1/xsnap-ocr.1 reads:
| > 
| > !   64  .IX Title "xsnap_ocr 1"
| > !   65  .TH xsnap_ocr 1 "2011-09-29" "xsnap-ocr" "User Commands"
| >     66  .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
| >     67  .\" way too many mistakes in technical documents.
| >     68  .if n .ad l
| >     69  .nh
| >     70  .SH "NAME"
| > !   71  xsnap_ocr \- OCR reader helper called by xsnap
| >     72  .SH "SYNOPSIS"
| > 
| > SUGGESTION
| > 
| > It would be nice if there were a P: or X: check to verify that
| > basename of manual page's filename (without suffix) matches the marked
| > (!) lines.
| > 
| > The above should have read:
| > 
| > !   64  .IX Title "xsnap-ocr 1"
| > !   65  .TH xsnap-ocr 1 "2011-09-29" "xsnap-ocr" "User Commands"
| >     ...
| > !   71  xsnap-ocr \- OCR reader helper called by xsnap
| > 
| > -- System Information:
| > [...]
| 
| What about manpages re-used for multiple commands? gzip, gunzip and zcat
| uses the same manpage, how would you expect this to be handled?

If it were classified "X:" and explanation reads "certainty: not
sure", I don't think there is not much problem. 

Jari




Reply to: