Package: abi-dumper
Version: 1.2-2
Severity: minor

The man page for this page has two examples which should look like this:
abi-dumper libTest.so -o ABI.dump 
abi-dumper Module.ko.debug -o ABI.dump

But actually look like this:
abi-dumper libTest.so -o ABI.dump abi-dumper Module.ko.debug -o ABI.dump
which is quite ocnfusing on first read, until you realise what has
gone wrong.

Looking at the source I see the manpage is generated from help2man
It comes out right if you do 'abi-dumper --help':
EXAMPLES:
  abi-dumper libTest.so -o ABI.dump
  abi-dumper Module.ko.debug -o ABI.dump

So apparently help2man is messing this up.

I've not investigated further (to find out why other linefeeds are
preserved but this one is lost), but running help2man on the binary
just built is a great way to make something un-crossbuildable so maybe
just making a manpage once and getting rid of help2man is the best
approach here? Help2man is 'handy' but it's also problematic. This
isn't a fast-moving project where the man page will go out of date all
the time so converting to a simple man page, or packaging-time
generation, rather than a build-time generation, would be good for
reproducibility and cross-buildability.

Would a patch to that effect be accepted?

-- 
Wookey

Reply via email to