Package: lifelines-doc
Version: 3.0.37.2-3
Severity: important

The package's file /usr/share/doc-base/lifelines-doc contains errors.

(1) The abstract is wrong, so the documentation is installed with a badly
    misleading description.
(2) The control fields are wrong for non-html; each format should only have
    one "Files" section.
(3) The control fields for html only enter one of the two manuals into the
    doc-base index.  It would be better if both manuals were entered.

Details:

(1) The abstract is wrong.  It currently says:

        Abstract: This manual describes what lifelines is
         and how it can be used to
          manage online manuals on Debian systems.

Surely lifelines is for managing genealogy data, not for managing online
manuals.  :-)

So shouldn't the abstract say something like this?

        Abstract: User guide and full programmer's manual for the
         lifelines genealogy software

(2) Installation of lifelines-doc generates these warnings:
Setting up lifelines-doc (3.0.37.2-3) ...
warning: files: overwriting previous setting of control field at
/usr/sbin/install-docs line 592, <IN> line 11.
warning: files: overwriting previous setting of control field at
/usr/sbin/install-docs line 592, <IN> line 15.
warning: files: overwriting previous setting of control field at
/usr/sbin/install-docs line 592, <IN> line 19.

This is because having two "Files" sections for one "Format" is not
supported.  Here is the relevant part of the doc-base manual, at
file:/usr/share/doc/doc-base/doc-base.html/ch2.html#s2.3

        Files 
                A filename or shell glob representing the files which
                constitute the in this format of the document. Required field.

So /usr/share/doc-base/lifelines-doc should have lines something like this
        Files: /usr/share/doc/lifelines-doc/ll-*.xml.gz


(3) The html section is unhelpful, because it only adds one of the two
manuals to the doc-base index.  Here is what it currently says:
        Format: HTML
        Files: /usr/share/doc/lifelines-doc/ll-userguide.html
        Index: /usr/share/doc/lifelines-doc/ll-userguide.html

Since the manual is in two parts (user guide, programmer's guide) it
would be better to ship a small ll-index.html something like this
<html>
<head><title>Lifelines manuals</title></head>
<body>
<a href="ll-userguide.html">Lifelines user guide</a>
<a href="ll-reportmanual.html">Report programming subsystem</a>
</body>
</html>

and try something like
        Format: HTML
        Index: /usr/share/doc/lifelines-doc/ll-index.html
        Files: /usr/share/doc/lifelines-doc/ll-*.html


-- System Information:
Debian Release: 3.1
Architecture: i386 (i686)
Kernel: Linux 2.4.27-2-686
Locale: LANG=en_GB, LC_CTYPE=en_GB (charmap=ISO-8859-1)

-- no debconf information



-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]

Reply via email to