tools documention



Gtk and friends come with a number of tools (gdk-pixbuf-csource,
glib-mkenums, etc). 
We currently install man pages for a subset of these. 
I'd like to integrate the tool documentation into the API docs. I believe
that has a number of 
advantages:

a) makes it possible to link to the tools docs from other parts of the docs
b) makes the tools docs easier available online
c) makes it easier to maintain and complete the tools docs (no need to learn
troff macros in addition to
docbook tags)

Man pages will still be installed (the docbook xsl stylesheets contain a
refentry -> man converter). The
setup will be similar to the other docs: generated docs are distributed and
only regenerated if configure is called with --enable-man.  This doesn't add
any new dependencies for the release-build machines, since they need to have
xsltproc and the docbook stylesheets anyway

I've added a patch showing how this works for gdk-pixbuf-csource to 
http://bugzilla.gnome.org/show_bug.cgi?id=114456

Does anybody think that this is not a good idea ?

Matthias


-- 
+++ GMX - Mail, Messaging & more  http://www.gmx.net +++
Bitte lächeln! Fotogalerie online mit GMX ohne eigene Homepage!




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