GNOME Bugzilla – Bug 668368
Use new documentation infrastructure (yelp-tools instead of gnome-doc-utils)
Last modified: 2013-07-21 17:08:00 UTC
Created attachment 205726 [details] [review] Use new documentation ingraestructure gnome-doc-utils is deprecated, use yelp-tools instead
Review of attachment 205726 [details] [review]: Thank you for the patch. With your patch applied, if I do: # cd jhbuild # ./autogen.sh --prefix=/tmp/jhb --enable-doc-installation=yes # make # make install # find /tmp/jhb -type f | grep help /tmp/jhb/share/help/C/jhbuild/figures/jhbuild_sample_dot_output.png The manual isn't installed.
Created attachment 207277 [details] [review] Use new documentation infraestructure.v2 New patch with some fixes: - Specify HELP_FILES - Main docbook file has to be named index.docbook http://www.freedesktop.org/wiki/Specifications/help-spec
Created attachment 208681 [details] [review] Use new documentation infraestructure.v3 Sorry, I attached the wrong patch before
Review of attachment 208681 [details] [review]: Thank you for the patch. Why the switch from gnome-help to yelp? Also README needs updating from gnome-help to yelp. Remove jhbuild.xml from .gitignore. ::: autogen.sh @@ +4,3 @@ # # For installation instructions please refer to the JHBuild manual: +# yelp /jhbuild-source-dir/doc/C/jhbuild.xml Should be index.docbook rather than jhbuild.xml @@ +7,1 @@ # where 'jhbuild-source-dir' is the full path to the JHBuild source directory. Don't need to specify 'full path' anymore. 'full path' was due to a bug with gnome-help and ghelp:/ addresses. ::: doc/C/index.docbook @@ +2,3 @@ +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!-- process to HTML with: xmlto xhtml-nochunks -m ../custom.xsl jhbuild.xml --> jhbuild.xml should be index.docbook
Created attachment 210006 [details] [review] Use new documentation infrastructure Updated patch with your comments The change is because gnome-doc-utils and xml2po are slowly being replaced by yelp-tools and itstool.
Comment on attachment 210006 [details] [review] Use new documentation infrastructure Thank you for your work on this. Committed. http://git.gnome.org/browse/jhbuild/commit/?id=6fdaf504a3977d0abc1541180c673eb48f6cf528
One thing I didn't test is if JHBuild releases still work. And the on-line manual [1] still gets updated correctly upon a release. Frédéric will let us know if its broken. [1] http://developer.gnome.org/jhbuild/stable/
Frédéric released JHBuild 3.4.0. It appears the release went smoothly and the on-line manual updated. Excellent work Javier.
To be honest this required changed to library-web as it didn't handle new build system and docbook docs...