Bugzilla – Bug 688032
libX11 documentation is in source form only
Last modified: 2011-09-05 14:00:12 UTC
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:2.0.0) Gecko/20100101 Firefox/4.0 The documentation included in xorg-x11-libX11 is in source form only (DocBook). It is not directly readable and no instruction is provided on how to read it. Reproducible: Always Steps to Reproduce: 1. { rpm '-qd' 'xorg-x11-libX11' | grep '-F' 'libX11'; } 2. { xdg-open /usr/share/doc/libX11/specs/libX11/libX11.xml; } Actual Results: 1. XML (DocBook) and SVG files. 2. Results vary; at best, XML source; at worst, an unreadable interpretation in Konqueror (KDE Bug 239979). Expected Results: 1. Something directly readable, e.g. PDF. Useful documentation can be generated using xsltproc but you need the exact invocation and the URL of the style sheet. However, I suppose that upstream build process already tells you exactly how to do it. I suggest removing the DocBook sources from xorg-x11-libX11 and packaging the documentation into xorg-x11-libX11-PDF (or whatever name seems appropriate).
Well, I tried before. ------------------------------------------------------------------- Tue Jan 18 16:32:18 UTC 2011 - sndirsch@novell.com - reverted previous change due to creation of a pretty huge build cycle according to coolo ------------------------------------------------------------------- Mon Jan 17 14:22:28 UTC 2011 - sndirsch@novell.com - added xmlto to BuildRequires to generate HTML documentation from XML sources
That's from xorg-x11-libX11 RPM changelog ...
How does typesetting libX11 documentation, a thing that every customer developer is expected to do by herself now, create a build cycle? Does xmlto depend on libX11? How about at least providing a script or some instruction on how to prepare the distributed source for reading? If typesetting HTML is a problem, how about DVI? PDF?
> Does xmlto depend on libX11? Yes, that's how I understood it.
(In reply to comment #4) > > Does xmlto depend on libX11? > > Yes, that's how I understood it. In that case we should use xmlto-mini instead.
(In reply to comment #5) > In that case we should use xmlto-mini instead. I'm not aware of such a package.
In that case, three solutions come to my mind: * create xmlto-mini, or * bootstrap libX11 on a previous release, or * build libX11-doc as a separate package. Building libX11-doc would depend on xmlto that depends on libX11, but libX11 would not depend on libX11-doc, so the circular dependency would be gone. I would personally opt for having xmlto-mini if possible.
KHelpCenter can read DocBook, e.g. KMail is documented in DocBook. Finding a way to plug the documentation into KHelpCenter would solve the problem for KDE (OTOH, you probably do not need that doc on KDE, unless you use KDE to develop for barebones that is).
xmlto depends on texlive-xmltex to produce PDF; but the standard build produces XHTML, not PDF. textlive, of course, pulls back X11 with it, so it cannot be done. And it is huge.
This is an autogenerated message for OBS integration: This bug (688032) was mentioned in https://build.opensuse.org/request/show/70708 Factory / xorg-x11-libX11
This is an autogenerated message for OBS integration: This bug (688032) was mentioned in https://build.opensuse.org/request/show/80955 Factory / xmlto