search

ibm-s390-linux / s390-tools

Tools for use with the s390 Linux kernel and device drivers
MIT License
62 stars 58 forks source link

several man page related lintian warning #170

Open frank-heimes opened 1 month ago

frank-heimes commented 1 month ago

Hi, bumping the Ubuntu version of s390-tools to 2.33.1, I thought to bring up the following warnings that (Debian) lintian spits out:

W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvattest-create.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvattest-perform.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvattest-verify.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvsecret-add.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvsecret-create-association.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvsecret-create-meta.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvsecret-create.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvsecret-list.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvsecret-lock.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man1/pvsecret-verify.1.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man8/lshwc.8.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man8/lspai.8.gz] W: s390-tools: bad-whatis-entry [usr/share/man/man8/pai.8.gz]

W: s390-tools: groff-message error: automatically ending diversion 'an-div' on exit [usr/share/man/man8/zcryptstats.8.gz:1]

( W: s390-tools: groff-message troff::120: warning: cannot select font 'F' [usr/share/man/man1/pvsecret-verify.1.gz:1] W: s390-tools: groff-message troff::120: warning: cannot select font 'F' [usr/share/man/man1/pvsecret-verify.1.gz:2] W: s390-tools: groff-message troff::120: warning: cannot select font 'F' [usr/share/man/man1/pvsecret-verify.1.gz:3] W: s390-tools: groff-message troff::120: warning: cannot select font 'F' [usr/share/man/man1/pvsecret-verify.1.gz:4] W: s390-tools: groff-message troff::120: warning: cannot select font 'F' [usr/share/man/man1/pvsecret-verify.1.gz:5] W: s390-tools: groff-message troff::132: warning: cannot select font 'F' [usr/share/man/man1/pvsecret-verify.1.gz:6] W: s390-tools: groff-message troff::13: error: a newline character is not allowed in an escape sequence parameter [usr/share/man/man8/lsqeth.8.gz:5] )

W: s390-tools: groff-message troff::13: error: a space character is not allowed in an escape sequence parameter [usr/share/man/man8/lsqeth.8.gz:1] W: s390-tools: groff-message troff::13: error: a space character is not allowed in an escape sequence parameter [usr/share/man/man8/lsqeth.8.gz:2] W: s390-tools: groff-message troff::13: error: a space character is not allowed in an escape sequence parameter [usr/share/man/man8/lsqeth.8.gz:3] W: s390-tools: groff-message troff::13: error: a space character is not allowed in an escape sequence parameter [usr/share/man/man8/lsqeth.8.gz:4]

W: s390-tools: groff-message troff::23: warning: macro 'create'' not defined [usr/share/man/man1/pvattest-create.1.gz:1] W: s390-tools: groff-message troff::450: warning: macro 'ID' not defined [usr/share/man/man8/lszdev.8.gz:1] W: s390-tools: groff-message troff::92: warning: macro 'SP' not defined [usr/share/man/man8/vmur.8.gz:1]

( W: s390-tools: groff-message troff::95: warning: cannot select font 'E' [usr/share/man/man1/pvsecret.1.gz:2] W: s390-tools: groff-message troff::95: warning: cannot select font 'F' [usr/share/man/man1/pvsecret.1.gz:1] W: s390-tools-chreipl-fcp-mpath: groff-message troff::146: warning: cannot select font 'C' [usr/share/man/man7/chreipl-fcp-mpath.7.gz:1] W: s390-tools-chreipl-fcp-mpath: groff-message troff::160: warning: cannot select font 'C' [usr/share/man/man7/chreipl-fcp-mpath.7.gz:2] W: s390-tools-chreipl-fcp-mpath: groff-message troff::169: warning: cannot select font 'C' [usr/share/man/man7/chreipl-fcp-mpath.7.gz:3] )

W: s390-tools: no-manual-page [sbin/sclpdbf] W: s390-tools: no-manual-page [sbin/scsi_logging_level] W: s390-tools: no-manual-page [usr/bin/pvextract-hdr] W: s390-tools: no-manual-page [usr/sbin/ip_watcher.pl] W: s390-tools: no-manual-page [usr/sbin/lsiucvallow] W: s390-tools: no-manual-page [usr/sbin/start_hsnc.sh] W: s390-tools: no-manual-page [usr/sbin/xcec-bridge]

These are not new, but I was hesitant to bring them up so far, because some (esp. the ones in brackets) are likely be caused by a slightly outdated version of pandoc: https://github.com/bin-cli/bin-cli/issues/44

For at least some 'bad-whatis-entry' reports it looks like the name and synopsis fields are combined and to complex for lexgrog (compare with zipl man page, that seems to be good).

For other reports like 'space character is not allowed in an escape sequence parameter' I can't spot the issue immediately (maybe line to long/complex for groff - but I'm here at least on the latest GNU groff version 1.23.0).

Anyway, nothing super serious of course, but might be worth to check if at least some cases can be polished.

steffen-eiden commented 1 month ago

Thanks, I will have a look