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 346905 - [PATCH] Attempt a port to gnome-doc-utils
[PATCH] Attempt a port to gnome-doc-utils
Status: RESOLVED FIXED
Product: totem
Classification: Core
Component: documentation
unspecified
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
Maintainers of Gnome user documentation
: 313336 (view as bug list)
Depends on:
Blocks: 351851
 
 
Reported: 2006-07-07 15:01 UTC by Don Scorgie
Modified: 2006-10-01 12:17 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Move to doc-utils (5.21 KB, patch)
2006-07-07 15:07 UTC, Don Scorgie
none Details | Review
Update (4.92 KB, patch)
2006-08-15 21:24 UTC, Don Scorgie
needs-work Details | Review
Update to address issues (3.96 KB, patch)
2006-08-16 18:21 UTC, Don Scorgie
none Details | Review
Updated patch, including a (rubbish) Spanish translation (81.22 KB, patch)
2006-08-25 17:40 UTC, Don Scorgie
none Details | Review
Updated patch (remove unnecessary files, migrate german translation) (220.53 KB, patch)
2006-09-29 18:42 UTC, Jan Arne Petersen
accepted-commit_now Details | Review

Description Don Scorgie 2006-07-07 15:01:41 UTC
Attached (with comments) in a second
Comment 1 Don Scorgie 2006-07-07 15:07:28 UTC
Created attachment 68569 [details] [review]
Move to doc-utils

Not entirely 100% certian this is correct, but it builds, validates and works for me (TM).

Additionally, a new directory, m4, is needed in the top level directory.  Inside this, the .cvsignore file should have "gnome-doc-utils.m4" in it.

The translations haven't been included and need to be done seperately.  I also backed away slowly from the strange looking directories (totem_volume_mute_button.png etc.  Yes, they are directories and they each have an omf file and a copy of totem.xml in them).  I'm not sure what they're for, but they don't seem to be referenced anywhere.

There is also a new Changelog file in the help directory for doc entries.
Comment 2 Baptiste Mille-Mathias 2006-08-15 20:00:37 UTC
Hello Bastien,

is it possible to have some feedback on this patch, in order to commit it, and update the totem doc in the 2.15 time-frame.

thanks
Comment 3 Don Scorgie 2006-08-15 21:24:15 UTC
Created attachment 70984 [details] [review]
Update

Apparently, the patch *cough* got mangled somewhat.  This should be the correct version.

Builds and runs make distcheck properly.  There are a couple of files in there that need to be CVS add'ed (help/totem.omf.in and help/Changelog)
Comment 4 Bastien Nocera 2006-08-16 08:02:05 UTC
(In reply to comment #2)
> Hello Bastien,

It's all nice trying to talk to me, but I wasn't anywhere on the CC: there.
Comment 5 Bastien Nocera 2006-08-16 08:06:06 UTC
Comment on attachment 70984 [details] [review]
Update

>Index: .cvsignore
>===================================================================
>RCS file: /cvs/gnome/totem/.cvsignore,v
>retrieving revision 1.8
>diff -u -r1.8 .cvsignore
>--- .cvsignore	20 Mar 2005 16:38:56 -0000	1.8
>+++ .cvsignore	15 Aug 2006 21:13:19 -0000
>@@ -27,3 +27,4 @@
> depcomp
> compile
> INSTALL
>+gnome-doc-utils.make
>Index: Makefile.am
>===================================================================
>RCS file: /cvs/gnome/totem/Makefile.am,v
>retrieving revision 1.13
>diff -u -r1.13 Makefile.am
>--- Makefile.am	11 Aug 2006 13:25:43 -0000	1.13
>+++ Makefile.am	15 Aug 2006 21:13:19 -0000
>@@ -14,11 +14,15 @@
> 	totem.spec		\
> 	omf.make		\
> 	totem-plparser.pc.in	\
>-	xmldocs.make
>+	xmldocs.make		\
>+	gnome-doc-utils.make
> 
> CLEANFILES = totem.spec totem-plparser.pc
> 
>-DISTCLEANFILES = intltool-extract intltool-merge intltool-update
>+DISTCLEANFILES = intltool-extract intltool-merge intltool-update \
>+		 gnome-doc-utils.make
> 
> pkgconfigdir = $(libdir)/pkgconfig
> pkgconfig_DATA = totem-plparser.pc
>+
>+DISTCHECK_CONFIGURE_FLAGS = --disable-scrollkeeper
>\ No newline at end of file
>Index: configure.in
>===================================================================
>RCS file: /cvs/gnome/totem/configure.in,v
>retrieving revision 1.290
>diff -u -r1.290 configure.in
>--- configure.in	15 Aug 2006 15:17:26 -0000	1.290
>+++ configure.in	15 Aug 2006 21:13:19 -0000
>@@ -20,6 +20,9 @@
> AM_GLIB_GNU_GETTEXT
> IT_PROG_INTLTOOL([0.35.0])
> 
>+AC_CONFIG_MACRO_DIR([m4])

Why do we need an m4 directory? It shouldn't be needed, as long as autogen.sh is updated to require the gnome-doc-utils version necessary.
<snip>
>-SUBDIRS = C bg de es fr ru uk
>+include $(top_srcdir)/gnome-doc-utils.make
>+dist-hook: doc-dist-hook
>+
>+DOC_MODULE = totem
>+DOC_ENTITIES = legal.xml
>+DOC_INCLUDES = 
>+
>+DOC_FIGURES  = 	figures/totem_show_playlist_button.png 	\
>+		figures/totem_next_button.png		\
>+		figures/totem_start_window.png		\
>+		figures/totem_pause_button.png		\
>+		figures/totem_volume_maximum_button.png	\
>+		figures/totem_play_button.png		\
>+		figures/totem_volume_mute_button.png	\
>+		figures/totem_previous_button.png
>+
>+DOC_LINGUAS = 

Where do you mention which languages are supported?
<snip>
>Index: help/C/totem.xml
>===================================================================
>RCS file: /cvs/gnome/totem/help/C/totem.xml,v
>retrieving revision 1.4
>diff -u -r1.4 totem.xml
>--- help/C/totem.xml	12 Aug 2006 08:14:36 -0000	1.4
>+++ help/C/totem.xml	15 Aug 2006 21:13:20 -0000
>@@ -33,6 +33,10 @@
>       <holder>Chee Bin HOH</holder> 
>     </copyright> 
> 
>+    <abstract role="description">
>+      <para>&app; is a video player for the GNOME desktop</para>

It's not a video player, it's a movie player.

Rest looks fine, pending testing.
Comment 6 Bastien Nocera 2006-08-16 08:07:25 UTC
*** Bug 313336 has been marked as a duplicate of this bug. ***
Comment 7 Don Scorgie 2006-08-16 18:21:21 UTC
Created attachment 71030 [details] [review]
Update to address issues

Removes the m4 directory.

Translations, when done, go in the DOC_LINUAS.  For now, I've readded them to be build on their own (using the old method).

Also changed video to movie in the description.

Builds, installs and make distcheck fine for me.
Comment 8 Bastien Nocera 2006-08-16 20:00:51 UTC
Does that mean that the other languages will need to be ported as well? Could you port at least one language (of your choice) as an example for others to finish up the patch?
Do you need to have C added to DOC_LINGUAS, or is it automatic?
Comment 9 Shaun McCance 2006-08-16 21:00:55 UTC
> Do you need to have C added to DOC_LINGUAS, or is it automatic?

C is handled automatically, though adding it won't have any adverse effects.
Comment 10 Baptiste Mille-Mathias 2006-08-25 06:47:34 UTC
Hello,

Would it be possible to commit this patch, it would help to finish the doc update for totem 1.6.0

thanks for your attention :)
Comment 11 Bastien Nocera 2006-08-25 10:19:47 UTC
I won't commit this until at least one other language is ported to gnome-doc-utils.
Comment 12 Don Scorgie 2006-08-25 17:40:33 UTC
Created attachment 71606 [details] [review]
Updated patch, including a (rubbish) Spanish translation

One patch, complete with translation.

Since I don't technically speak Spanish and had some difficulty merging the po file (which seems to be because the Spanish docbook is slightly older than the C version), the translation itself probably doesn't make much sense and probably shouldn't be used.  There are also guidelines for moving translations to gnome-doc-utils at:
http://live.gnome.org/GnomeDocUtilsTranslationMigration

(Note since Doric isn't available, I couldn't really do a translation properly :( )

Note also that the previous patch seems to be missing the omf.in and Changelog entries (damned CVS).
Comment 13 Jan Arne Petersen 2006-09-29 18:42:34 UTC
Created attachment 73664 [details] [review]
Updated patch (remove unnecessary files, migrate german translation)
Comment 14 Bastien Nocera 2006-09-30 16:39:21 UTC
Looks good, please commit to HEAD.
Comment 15 Jan Arne Petersen 2006-10-01 12:17:22 UTC
2006-10-01  Jan Arne Petersen  <jpetersen@jpetersen.org>

	* .cvsignore:
	* Makefile.am:
	* configure.in:
	* help/.cvsignore:
	* help/ChangeLog:
	* help/Makefile.am:
	* help/totem.omf.in:
	* help/C/totem.xml:
	* help/de/.cvsignore:
	* help/de/de.po:
	* help/es/.cvsignore:
	* help/es/es.po: migrate help documentation to gnome-doc-utils. Based
	on a patch from Don Scorgie <dscorgie@cvs.gnome.org>. (Closes: 346905)

	* help/C/Makefile.am:
	* help/C/totem-C.omf:
	* help/de/Makefile.am:
	* help/de/legal.xml:
	* help/de/totem-de.omf:
	* help/de/totem.xml:
	* help/es/Makefile.am:
	* help/es/legal.xml:
	* help/es/totem-es.omf:
	* help/es/totem.xml:
	* help/omf.make:
	* help/xmldocs.make: remove unneccessary files.