GNOME Bugzilla – Bug 682077
Build manual with xsltproc instead of docbook2html
Last modified: 2013-04-09 19:00:30 UTC
docbook2html is difficult to build (for me), but makefile suggested that xsltproc can be used instead. Making it happen involves the following: 1) fix gst-doc.m4 to not to require docbook2html to build html manual 2) fix gst-doc.m4 to not to list fig2dev as a mandatory requirement (detection code says that without it some images won't be built, but building the manual should still be possible; also see (5)) 3) fix as-docbook.m4 to understand XML_CATALOG_FILES environment variable. as-docbook.m4 looks for hard-coded /etc/xml/catalog, and if it isn't there, looks for some hardcoded docbook files. Instead if should honor XML_CATALOG_FILES, just as libxml2 does. XML_CATALOG_FILES is a space-delimited list of files. 4) fix manual.mak - remove the comment that suggests xsltproc usage, replace docbook2html with xsltproc. Remove sed invocation. 5) remove .fig files from the manual. There is only one such file - state-diagram.fig, and it's not used anyway. Without fig2dev it can't be converted to png, and makefile if written in a way that makes fig2dev non-optional. I don't know how to make fig2dev invocation optional in a clean way, so i think that .fig file should be moved instead
Created attachment 221563 [details] [review] [common] Build html manual with xsltproc, images are optional
Created attachment 221564 [details] [review] [common] Support XML_CATALOG_FILES
Created attachment 221566 [details] [review] [core] Use xlstproc instead of docbook2html
Created attachment 221567 [details] [review] [core] Move unused state-diagram out of the way.
Diagram-moving patch is now obsolete, after http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=9301305cd6533b2001f11f5253858bbea9d6a076
Alternatively, JH_PATH_XML_CATALOG (used, for example, by glib) can be used in as-docbook instead. It doesn't support XML_CATALOG_FILES either (there's a bug #683554 about it), but does support --with-xml-catalog, which is good enough for me.
Comment on attachment 221567 [details] [review] [core] Move unused state-diagram out of the way. Diagram-moving patch is now obsolete, after http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=9301305cd6533b2001f11f5253858bbea9d6a076
Created attachment 240476 [details] [review] Don't need docbook2html anymore
Other patches should apply as-is
Review of attachment 221566 [details] [review]: ::: docs/faq/faq.xml @@ +21,3 @@ <!ENTITY LEGAL SYSTEM "legal.xml"> ]> +<?xml-stylesheet href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"?> this should not be needed. could you try without?
Review of attachment 240476 [details] [review]: There is an earlier AC_CHECK_PROG(HAVE_DOCBOOK2PS, docbook2ps, yes, no) that looks like it should be removed too, istead you should probably look for xsltproc now.
Created attachment 240522 [details] [review] Don't need docbook2html anymore, need xlstproc Remove any mentions of docbook2html, look for xlstproc instead.
Created attachment 240523 [details] [review] Use xsltproc instead of docbook2html (v2) This version is without an extra xml-stylesheet tag.
Fixed the patches as suggested.