Your message dated Fri, 25 Dec 2009 14:40:33 -0500
with message-id <[email protected]>
and subject line Re: Bug#562030: debhelper: dh_installmanpod - Add support for 
debian/manpage.N.pod files
has caused the Debian Bug report #562030,
regarding debhelper: dh_installmanpod - Add support for debian/manpage.N.pod 
files
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact [email protected]
immediately.)


-- 
562030: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=562030
Debian Bug Tracking System
Contact [email protected] with problems
--- Begin Message ---
Package: debhelper
Version: 7.4.10
Severity: wishlist


Some packages do not include manual pages, so writing an accompanying
page in Perl POD syntax is easily maintable.

There manual page files would be stored using syntax:

        debian/<filename>.<section>.pod

A new utility dh_installmanpod would examine these files, turn them into
manual pages (pod2man) and install them in appropriate location
specified by <section>.

The following may give implementation ideas. I've used somthing like
this in a Makefile; presented here in a pseudo code form:


    MANPOD          = <the *.pod file>
    MANSECT         = <extracted from filename>
    MANPAGE         = <filename without *.pod suffix>
    PODCENTER       = $(date "+%Y-%m-%d")
    POD2MAN_FLAGS   = --utf8

    LC_ALL= LANG=C pod2man $POD2MAN_FLAGS \
            --center="$PODCENTER" \
            --name="$PACKAGE" \
            --section="$MANSECT" \
            $(MANPOD) \
    | sed "s,[Pp]erl v[0-9.]*,$PACKAGE," \
      > $MANPAGE && \
    rm -f pod*.tmp

The 'sed' cleanup replaces 'Perl vN.N' text with the package
name. Perhaps there is an option that would make the sed irrelevant.

-- System Information:
Debian Release: squeeze/sid
  APT prefers testing
  APT policy: (990, 'testing'), (500, 'unstable'), (1, 'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 2.6.30-2-amd64 (SMP w/2 CPU cores)
Locale: LANG=en_DK.UTF-8, LC_CTYPE=en_DK.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages debhelper depends on:
ii  binutils                      2.20-4     The GNU assembler, linker and bina
ii  dpkg-dev                      1.15.5.4   Debian package development tools
ii  file                          5.03-3     Determines file type using "magic"
ii  html2text                     1.3.2a-14  advanced HTML to text converter
ii  man-db                        2.5.6-4    on-line manual pager
ii  perl                          5.10.1-8   Larry Wall's Practical Extraction 
ii  perl-base                     5.10.1-8   minimal Perl system
ii  po-debconf                    1.0.16     tool for managing templates file t

debhelper recommends no packages.

Versions of packages debhelper suggests:
ii  dh-make                       0.50       tool that converts source archives

-- debconf-show failed



--- End Message ---
--- Begin Message ---
jaalto wrote:
> 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.
   Probably more than it would make sense to support in debhelper
   command(s).
   
   (Especially when you consider the aggregate complexity of various
   options that can be passed when building them. For example, pod2man
   needs --release and --section and often --center.)

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.

-- 
see shy jo

Attachment: signature.asc
Description: Digital signature


--- End Message ---

Reply via email to