[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Debhelper - docbookxml manpages

On 17-08-2007, Daniel Leidert <daniel.leidert.spam@gmx.net> wrote:
> Am Freitag, den 17.08.2007, 12:11 +0200 schrieb Carl Fürstenberg:
>> On 8/17/07, Sylvain Le Gall <gildor@debian.org> wrote:
> [..]
>> > Maybe you could split the thing as this :
>> > * define a debian/XXX.docbookxmlmanpages file, it contains all
>> >   the toplevel xml file to install (firt column) and the generated manpage
>> >   (optional, second column).
> When you use a make-snippet, you could also define the manpages to
> create and write a rule, howto create e.g. .1 from .1.xml. In make:
> .SUFFIXES: .xml
> .xml:
> 	xsltproc ... $< ...

Unfortunately, there was no real former policy concerning docbook xml
file name... Most of the docbook xml manpage are simple "XXX.xml" and
sometimes "XXX.dbk" (and XXX.1.xml and XXX.1perl.xml...). Thats the
reason why it is better, to my mind, to guess it at build time (rather
than listing all possible suffixes). But that is the way i was doing
thing before CDBS (which are after all kind of makefile snippet). 

I think CDBS/debhelper/makefile snippet can coexist. We just need to set
the thing such as building is done in CDBS/makefile (because it is the
best place to put it) and installing is done through debhelper.

> This is not necessary. Check the man.output.manifest.enabled parameter
> of docbook-xsl. The created file contains the names and paths (the
> latter if subdirs are enabled) of all created manpages. You can safely
> use this this option and then check the created manifest (change the
> filename of this file via the man.output.manifest.filename parameter).
>> in the cdbs version to know what to remove, and in the
>> debhelper version to know what file to install.

This manifest thing can be very useful. I will keep it in mind for my
next version of CDBS class.

In fact, i speak with someone at the last Debconf about building
something more clever with docbook -- not limited to manpage. So maybe
we can extend the use of the debhelper script to analyze the content of
the Docbook XML and generate a list of available options to complete a
file that will be used to do bash completion (using info provided in the
cmdsynopsys section...).

The debhelper script is a perfect place to do this ! (please comment
this statement ;-)

Sylvain Le Gall

Reply to: