Bug#947258: lintian: manpage-without-executable is too strict (false positives for subcommand man pages)
Control: affects 947258 + libreswan On Fri 2020-05-22 10:46:29 -0700, Felix Lechner wrote: > So far, I learned that 'man' interprets two commands by default as a > sub-command [1] […] > [1] https://stackoverflow.com/a/32750157 Thanks for this pointer, interesting! > but I do not know how to tell from a man page that it is for a > sub-command like 'git add' instead of a command called git-add. > > I do not believe there is an annotation for it, although there > probably should be. I'm also unaware of anything like this. I don't know where would be the best place to try to establish such a convention. Any suggestions? > Unless someone has a better idea, I think we have parse the output > generated by 'groff -man -Tascii'. Similar to man's strategy [1] a man > page would be deemed to relate to a sub-command when the first two > words in the synopsis, connected by a hyphen, are the same as the file > name. It's not just the hyphen -- we should consider connection by an underscore as well (as libreswan's manpages do). --dkg signature.asc Description: PGP signature
Bug#947258: lintian: manpage-without-executable is too strict (false positives for subcommand man pages)
Hi Daniel, On Mon, Dec 23, 2019 at 10:06 AM Daniel Kahn Gillmor wrote: > > If there is a way that notmuch, git, and other subcommand-style tools > should be annotating their manpages to avoid triggering this lintian > report, please update lintian's tag description to point to how to do > this. So far, I learned that 'man' interprets two commands by default as a sub-command [1] but I do not know how to tell from a man page that it is for a sub-command like 'git add' instead of a command called git-add. I do not believe there is an annotation for it, although there probably should be. Unless someone has a better idea, I think we have parse the output generated by 'groff -man -Tascii'. Similar to man's strategy [1] a man page would be deemed to relate to a sub-command when the first two words in the synopsis, connected by a hyphen, are the same as the file name. Kind regards Felix Lechner [1] https://stackoverflow.com/a/32750157
Bug#947258: lintian: manpage-without-executable is too strict (false positives for subcommand man pages)
Package: lintian Version: 2.41.0 Control: affects -1 notmuch The stated version of lintian (and later) produces a manpage-without-executable warning that is far too strict for modern subcommand-oriented interfaces. For example, on the notmuch package, lintian 2.42.0 emits: I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-address.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-compact.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-config.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-count.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-dump.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-insert.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-new.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-reindex.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-reply.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-restore.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-search.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-setup.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-show.1.gz I: notmuch: manpage-without-executable usr/share/man/man1/notmuch-tag.1.gz But of course these are all manpages for subcommands of notmuch, documented in much the same way that git-tag.1 documents git's subcommand "tag". While we can override these tags in the notmuch packaging source, it seems like it would be better if lintian were more clever about how to recognize the legitimate error it's trying to document. If there is a way that notmuch, git, and other subcommand-style tools should be annotating their manpages to avoid triggering this lintian report, please update lintian's tag description to point to how to do this. Thanks for your work in improving debian! Regards, --dkg signature.asc Description: PGP signature
