After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 689019 - Port to new documentation infrastructure
Port to new documentation infrastructure
Status: RESOLVED FIXED
Product: ghex
Classification: Applications
Component: general
3.6.x
Other Linux
: Normal normal
: ---
Assigned To: GHex maintainers
GHex maintainers
Depends on:
Blocks: 681609
 
 
Reported: 2012-11-25 10:53 UTC by Javier Jardón (IRC: jjardon)
Modified: 2012-12-20 07:59 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Use-yelp-tools-instead-gnome-doc-utils (61.74 KB, patch)
2012-12-11 04:53 UTC, Javier Jardón (IRC: jjardon)
needs-work Details | Review
Use-yelp-tools-instead-gnome-doc-utils.v2 (62.63 KB, patch)
2012-12-20 07:26 UTC, Javier Jardón (IRC: jjardon)
committed Details | Review

Description Javier Jardón (IRC: jjardon) 2012-11-25 10:53:19 UTC
Yse yelp-tools instead gnome-doc-utils

See https://live.gnome.org/GnomeGoals/NewDocumentationInfrastructure
Comment 1 Javier Jardón (IRC: jjardon) 2012-12-11 04:53:30 UTC
Created attachment 231233 [details] [review]
Use-yelp-tools-instead-gnome-doc-utils
Comment 2 Kalev Lember 2012-12-19 11:28:47 UTC
Hi Javier,

Thanks for the patch! I actually tried to do the same thing half a year ago, but ended up reverting it because it caused too much translation coverage loss to my liking. The switch to itstool caused a lot of new xml tags to appear in translatable messages, for instance:

xml2po (gnome-doc-utils):
#: C/ghex.xml:541(guilabel)
msgid "Unsigned 8 bit"

itstool:
#. (itstool) path: listitem/para
#: C/index.docbook:541
msgid "<guilabel>Unsigned 8 bit</guilabel>"

I filed an itstool bug back then, but Shaun thought that the current behaviour is expected. https://bugs.freedesktop.org/show_bug.cgi?id=50006

What do you think, should we go ahead this even with the translation loss?

For reference, this is my port to the new documentation infrastructure from half a year ago:
http://git.gnome.org/browse/ghex/commit/?id=8b0824b0

... and the revert:
http://git.gnome.org/browse/ghex/commit/?id=316350e9
Comment 3 Javier Jardón (IRC: jjardon) 2012-12-19 11:53:36 UTC
Hi Kalev,

My recommendation is to apply this, as this is the last module to be ported to get rid of gnome-doc-utils from GNOME releases.
Also, we are still in the beginning of the cycle, so time enough to update translations.
Comment 4 Kalev Lember 2012-12-19 18:48:33 UTC
Review of attachment 231233 [details] [review]:

Okay, fair enough, let's port ghex as well then.

Some issues with the patch:
 1) Should remove "--disable-scrollkeeper" that's passed to DISTCHECK_CONFIGURE_FLAGS in Makefile.am
 2) help/ghex.omf.in is no longer needed and can be removed.
 3) src/ui.c includes ghex-docs.h for documentation credits, but this file is no longer generated with yelp-tools, breaking the build.
Comment 5 Javier Jardón (IRC: jjardon) 2012-12-20 07:26:01 UTC
Created attachment 231970 [details] [review]
Use-yelp-tools-instead-gnome-doc-utils.v2

Thanks for the review.
New patch attached
Comment 6 Kalev Lember 2012-12-20 07:58:38 UTC
Review of attachment 231970 [details] [review]:

Excellent, thanks! I've pushed this to master and released ghex 3.7.1 with it.