Problems with the man pages tarball

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

Problems with the man pages tarball

Dirk Eddelbuettel
I tried to package the manpages tarball, but there are issues concerning
(file-)name space pollution:

edd@basebud:/var/local/cache/pbuilder/result> wajig install quantlib-manpages_0.3.5-1_all.deb
(Reading database ... 108087 files and directories currently installed.)
Unpacking quantlib-manpages (from quantlib-manpages_0.3.5-1_all.deb) ...
dpkg: error processing quantlib-manpages_0.3.5-1_all.deb (--install):
 trying to overwrite /usr/share/man/man3/index.3.gz', which is also in package manpages-dev
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
dpkg-deb: subprocess paste killed by signal (Broken pipe)
Errors were encountered while processing:
 quantlib-manpages_0.3.5-1_all.deb
edd@basebud:/var/local/cache/pbuilder/result>

man/man3/index.3 is a little too generic. The documentation for one of our
build-tools, dh_installman, mentions

     dh_installman is a debhelper program that handles installing man pages
     into the correct locations in package build directories. You tell it
     what man pages go in your packages, and it figures out where to install
     them based on the section field in their .TH line. If you have a prop-
     erly formatted .TH line, your man page will be installed into the right
     directory, with the right name (this includes proper handling of pages
     with a subsection, like "3perl", which are placed in man3, and given an
     extension of ".3perl"). If your .TH line is incorrect or missing, the
     program may guess wrong based on the file extension.

so I was hopeful, but it turns out that we already have a .TH line:

basebud:/home/edd/chibud/src/debian/QuantLib/QuantLib-manpages-0.3.5# head -1 man/man3/index.3
.TH "index" 3 "23 Mar 2004" "QuantLib" \" -*- nroff -*-

and I don't quite understand why that doesn't cut it.

What would people think if we a) either told doxygen to create all pages as
.3ql (if there is such a switch), or barring that, rename all file .3 into
.3ql ourselves?

Another problem came up overnight:


Delivery-date: Sun, 28 Mar 2004 07:40:38 -0600
From: [hidden email] (Anacron)
To: [hidden email]
Subject: Anacron job 'cron.daily'

/etc/cron.daily/man-db:
mandb: warning: whatis for history.3.gz exceeds 2048 bytes, truncating.


So it looks as if at least that page isn't created quite right.

Shall we tackly these issues, or should we be content with the other
documentation (already in Debian as .pdf and .html) ?

Dirk

--
The relationship between the computed price and reality is as yet unknown.  
                                             -- From the pac(8) manual page