Package: lintian
Severity: wishlist

For manual pages generated by tools like help2man that run binaries to
get usage statements for conversion to manual page format, please check
that the manual pages do not contain common text indicating that the
executable or script was not able to run successfully, so didn't output
any usage statement and so a useful manual page was not generated.

For example when running an ELF executable:

   $ ./src/jbig2
   jbig2: error while loading shared libraries: libjbig2enc.so.0: cannot open 
shared object file: No such file or directory
   
   $ zcat /usr/share/man/man1/jbig2.1.gz
   .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
   .TH JBIG2: "1" "February 2024" "jbig2: error while loading shared libraries: 
libjbig2enc.so.0: cannot open shared object file: No such file or directory" 
"User Commands"
   .SH NAME
   jbig2: \- encoder for JBIG2
   .SH DESCRIPTION
   src/jbig2: error while loading shared libraries: libjbig2enc.so.0: cannot 
open shared object file: No such file or directory

For example when running a Python script:

   $ ./foo.py 
   Traceback (most recent call last):
     File "./foo.py", line 2, in <module>
       import bar
   ImportError: No module named bar
   
   $ help2man --no-discard-stderr ./foo.py 
   .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
   .TH TRACEBACK "1" "May 2024" "Traceback (most recent call last):"
"User Commands"
   .SH NAME
   Traceback \- manual page for Traceback (most recent call last):
   .SH DESCRIPTION
   .SS "Traceback (most recent call last):"
   .IP
   File "./foo.py", line 2, in <module>
   .IP
   import bar
   .PP
   ImportError: No module named bar
   .IP
   File "./foo.py", line 2, in <module>
   .IP
   import bar
   .PP
   ImportError: No module named bar
   .SH "SEE ALSO"
   The full documentation for
   .B Traceback
   is maintained as a Texinfo manual.  If the
   .B info
   and
   .B Traceback
   programs are properly installed at your site, the command
   .IP
   .B info Traceback
   .PP
   should give you access to the complete manual.

-- 
bye,
pabs

https://wiki.debian.org/PaulWise

Attachment: signature.asc
Description: This is a digitally signed message part

Reply via email to