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 683296 - Port to new documentation infrastructure
Port to new documentation infrastructure
Status: RESOLVED FIXED
Product: gnome-panel
Classification: Other
Component: docs
3.5.x
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
Panel Maintainers
Depends on:
Blocks: 681609
 
 
Reported: 2012-09-03 21:07 UTC by Javier Jardón (IRC: jjardon)
Modified: 2012-09-04 11:04 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Port to new documentation infrastructure (55.46 KB, patch)
2012-09-03 21:07 UTC, Javier Jardón (IRC: jjardon)
reviewed Details | Review
Port to new documentation infrastructure.v2 (55.42 KB, patch)
2012-09-04 08:20 UTC, Javier Jardón (IRC: jjardon)
committed Details | Review

Description Javier Jardón (IRC: jjardon) 2012-09-03 21:07:05 UTC
Created attachment 223378 [details] [review]
Port to new documentation infrastructure

Use yelp-tools instead of gnome-doc-utils

See https://live.gnome.org/GnomeGoals/NewDocumentationInfrastructure
Comment 1 Germán Poo-Caamaño 2012-09-03 21:22:03 UTC
Review of attachment 223378 [details] [review]:

It seems this patch does not update the translation files.
Something like the following should do the trick:

$ for i in $(find help/clock -name '*.po'); do sed -i 's|C/clock.xml|C/index.docbook|g' $i;done
$ for i in $(find help/fish -name '*.po'); do sed -i 's|C/fish.xml|C/index.docbook|g' $i;done

This will avoid unnecessary double work for translator.
Comment 2 Vincent Untz 2012-09-04 06:04:18 UTC
Review of attachment 223378 [details] [review]:

I wonder why git didn't show a move from clock.xml to index.docbook. Were there many changes in the file?

::: gnome-panel/panel.c
@@ +700,3 @@
 		    g_ascii_strncasecmp (uri, "ftp:", strlen ("ftp:")) == 0 ||
 		    g_ascii_strncasecmp (uri, "gopher:", strlen ("gopher:")) == 0 ||
+		    g_ascii_strncasecmp (uri, "help:", strlen ("help:")) == 0 ||

This is actually wrong: ghelp is still a valid scheme. You should add help, but not remove ghelp.

::: help/clock/Makefile.am
@@ +6,3 @@
+	index.docbook \
+	legal.xml
+

Could you also define an empty HELP_MEDIA variable?

::: help/fish/Makefile.am
@@ +6,3 @@
+	index.docbook \
+	legal.xml
+

Could you also define an empty HELP_MEDIA variable?
Comment 3 Javier Jardón (IRC: jjardon) 2012-09-04 08:20:23 UTC
Created attachment 223403 [details] [review]
Port to new documentation infrastructure.v2

Updated patch with your comments

The only change in the index.docbook page is the change of some ghelp:->help: uris
Comment 4 Vincent Untz 2012-09-04 08:39:10 UTC
Review of attachment 223403 [details] [review]:

Looks good, but I just realized that you didn't change applets/clock/clock-utils.c to use help instead of ghelp. Please commit with this additional change :-)
Comment 5 Javier Jardón (IRC: jjardon) 2012-09-04 11:04:13 UTC
Comment on attachment 223403 [details] [review]
Port to new documentation infrastructure.v2

committed with the little fix: commit 515d89b7ef83f1f8d8938de0ff84d4424797f478
Comment 6 Javier Jardón (IRC: jjardon) 2012-09-04 11:04:32 UTC
Thanks for your fast review! :)