ow...@bugs.debian.org (Debian Bug Tracking System) writes:
>> Some packages do not include manual pages, so writing an accompanying
>> page in Perl POD syntax is easily maintable.
>
> While I write a fair bit of man pages as POD, I don't think this is an
> especially good idea, for two reasons:
>
> 1. There are plenty of other formats, such as docbook that can be used.

None of the recommended standard choices:

    $ dpkg -L dh-make | grep man.*x
    /usr/share/debhelper/dh_make/debian/manpage.1.ex
    /usr/share/debhelper/dh_make/debian/manpage.sgml.ex
    /usr/share/debhelper/dh_make/debian/manpage.xml.ex

are comparable from an easy maintenenace point of view; the Perl POD is
much more better than any of the above formats. The only similar
alternative would be asciidoc, but that woudl be Python dependent.

It would be good to offer POD as a choice because Perl is the language
of the Debian infrastructure.

> 2. If one is writing a man page for a package, it would make sense in
>    most cases to contribute it upstream. Which would include modifying
>    the upstream build system to build and install it. Which, if done,
>    means no debhelper command is needed.

Of course, but there are cases where no upstream no longer exists.

Jari



-- 
To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org

Reply via email to