Bug#777405: perl: pod2man puts object references into man page headers when used inside a pipe

[Axel Beckert]

user reproducible-builds at lists.alioth.debian.org

clone -1 -2
reassign -2 wml 2.0.12ds1-3
retitle -2 wml: Will FTBFS with future pod2man releases due to missing --name parameter
severity -2 important
usertag -2 - toolchain
tag -2 - fixed-upstream

clone -1 -3
reassign -3 libconfig-model-perl 2.061-1
retitle -3 libconfig-model-perl: config-edit(1p) should not recommend to use pod2man in a pipe without "--name"
usertag -3 - toolchain randomness
tag -3 - fixed-upstream

clone -1 -4
reassign -4 fvwm 1:2.6.5.ds-3
retitle -4 fvwm: "fvwm-perllib man" uses pod2man in a pipe without "--name" (will fail with future pod2man releases)
usertag -4 - toolchain randomness
tag -4 - fixed-upstream

kthxbye

Hi again,

Russ Allbery wrote:
> You need to tell pod2man what the title of the man page is, using the
> --name flag.  Given a pipe, it has no idea what to use for that field
> unless you tell it.

Axel Beckert wrote:
> I really like that solution: It will cause a few FTBFS and hence make
> this issue fixed whereever it shows up.

After zfgrepping through all installed man pages on three Jessie/Sid
installations of mine, I've just found my own package "wml" as
affected package.

I also noticed that only wml packages in Wheezy and later are affected
and that this behaviour was introduced by patch of mine
(debian/patches/fix-WML_VERSION-in-manpage.diff[1]) which fixed
#652567[2].

[1] https://sources.debian.net/src/wml/2.4.0ds1-1/debian/patches/fix-WML_VERSION-in-manpage.diff/
[2] http://bugs.debian.org/652567

Debian Code Search though shows a bunch of packages more[3], partially
also only documenting to use pod2man in a pipe. Most of them though
use either -n or --name.

[3] http://codesearch.debian.net/results/%5C%7C%20pod2man

I'm cloning this bug report for those additional cases I've found
where pod2man is used in a pipe but without -n or --name:

* config-edit(1p) of libconfig-model-perl currently recommends:

       To get man pages or text docuement, you can pipe the output of
       the command:

        config-edit -model Popcon -doc  | pod2man > popcon-conf.3

* "fvwm-perllib man" (of the fvwm package) uses pod2man in a pipe to
  dynamically generate and show man pages. They also show the object
  reference in the first line of the generated man page:

  IO::File=IO(0x19e6820)(3)      Fvwm Perl library     IO::File=IO(0x19e6820)(3)

		Regards, Axel
-- 
 ,''`.  |  Axel Beckert <abe at debian.org>, http://people.debian.org/~abe/
: :' :  |  Debian Developer, ftp.ch.debian.org Admin
`. `'   |  4096R: 2517 B724 C5F6 CA99 5329  6E61 2FF9 CD59 6126 16B5
  `-    |  1024D: F067 EA27 26B9 C3FC 1486  202E C09E 1D89 9593 0EDE