[Pkg-emboss-devel] Antwort: [EMBOSS] Manpage generator

[Charles Plessy]

Le Sun, Jul 15, 2007 at 10:35:49PM +0200, Daniel Leidert a écrit :
> Because I don't get any answer on my PMs, I send this to the list
> instead:

Hi Daniel,

thank you for your feedback, I was just keeping your PM for this weekend
as I waited for the release of EMBOSS 5.0.0 to continue my work.

I used /usr/share/doc/docbook-xsl/examples/foo.1.example_manpage.xml.gz
as a template, from the 1.72.0.dfsg.1-1 package. Some of the errors you
spotted originate from this.

> About the dhdate entity: The date is automatically added when creating
> the manpage via xsltproc (that's a part of the docbook-xsl features).
> You don't need to create an entity nor use the <date> tag.

Taken from the template ; corrected.

> In debian/rules you write: xsltproc -''-nonet. The "-''-" is just a
> workaround for the XML template. In XML it is not allowed to have "--"
> inside a comment, so we use "-''-" as workaround for options. But you
> can remove the "''" in debian/rules.

Taken from the template ; corrected.

> Further you use: -o debian/manpages/$$basename.1. This option doesn't
> work for manpages. The basename is always determined from the manpage
> source. You cannot change nor determine it via the -o option of
> xsltproc. You can only use this option to set the output directory: `-o
> debian/manpages/' but not the manpage name.

Corrected.

> 
> I further suggest to set the man.charmap.use.subset parameter to zero
> when creating the manpages.

Corrected. Maybe you can explain the rationale (sparing buildd time ?)
in the template ?


> Another suggestion: There is a typo bug "developpers". It only contains
> one "p", although the double "p" variant seems to be used in a few
> locations. But AFAIK there is no official word with double p.

Oops, this is frenglich.

> Then I would suggest to use
> 
> "[..] <package>EMBOSS</package> (<quote>European Molecular Biology Open
> Software Suite</quote>) [..]" once per manpage - maybe in DESCRIPTION or
> in <legalnotice> to determine, what EMBOSS stands for.

Inserted in description.


> Then in the right lower corner of the manpage I find e.g. "edialign
> 4.1.0". Shouldn't this be "EMBOSS 4.1.0" and
> "<productname>&dhproduct;</productname>"?

Excellent !

Many thanks,

if you want, you can have a look at the diffs in the following page :

http://lists.alioth.debian.org/pipermail/pkg-emboss-commits/2007-July/000046.html

Have a nice day,

-- 
Charles