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 704634 - Switch from gnome-doc-utils to yelp-tools
Switch from gnome-doc-utils to yelp-tools
Status: RESOLVED FIXED
Product: gparted
Classification: Other
Component: docs
unspecified
Other All
: Normal normal
: ---
Assigned To: gparted maintainers alias
gparted maintainers alias
Depends on:
Blocks: 681609
 
 
Reported: 2013-07-21 03:00 UTC by Jeremy Bicha
Modified: 2019-06-26 09:25 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Switch from gnome-doc-utils to yelp-tools (25.82 KB, patch)
2013-07-21 03:00 UTC, Jeremy Bicha
none Details | Review
Switch from gnome-doc-utils to yelp-tools (26.29 KB, patch)
2013-07-21 03:03 UTC, Jeremy Bicha
none Details | Review
Fix help link for gnome-desktop 3.5+ (21.44 KB, patch)
2013-08-01 02:34 UTC, Jeremy Bicha
none Details | Review

Comment 1 Jeremy Bicha 2013-07-21 03:00:36 UTC
Created attachment 249736 [details] [review]
Switch from gnome-doc-utils to yelp-tools
Comment 2 Jeremy Bicha 2013-07-21 03:03:35 UTC
Created attachment 249738 [details] [review]
Switch from gnome-doc-utils to yelp-tools
Comment 3 Mike Fleetwood 2013-07-21 10:59:09 UTC
Hi Jeremy,

Thanks for the patch.  Unfortunately this breaks the build on Debian 6
(which uses GNOME 2).  In fact GParted is still a GNOME 2 application and
aims to build and run on all distributions still supported upstream.  From
the referenced GNOME page:

  IMPORTANT: Do not port to the new system if the application still needs
  to run under GNOME 2. Yelp 2 does not recognize the new help system.

At the moment I don't thing GParted can switch yelp-tools.

Thanks,
Mike
Comment 4 Jeremy Bicha 2013-07-21 15:26:43 UTC
Officially, Debian 6 "oldstable" only provides gparted 0.7. Debian 6 will be supported until May 2014.

I guess we could refactor this patch to use yelp-tools at compile time if it's available and fall back to gnome-doc-utils otherwise.
Comment 5 Curtis Gedak 2013-07-22 02:32:09 UTC
Hi Jeremy,

Thank you for your interest in GParted and the patch along with this report.

With patches, we try to leave all of the changes in language translations to the GNOME Translation project.  As such one change you might consider in your patch is to drop all of the changes to cs.po,, de.po, etc.


In the GParted project we try to ensure that GParted compiles and runs on all currently supported major GNU/Linux distributions.  That is why Mike mentioned Debian 6 compatibility.

As Mike correctly points out, GParted is only GNOME 2 at this point so there is much more work to be done before it will compile and run under GNOME 3.

One of the initial steps is tracked in the following report:
Bug #652044 - uses deprecated APIs

With backward compatibility in mind, we will likely need to support both GNOME 2 and GNOME 3 in the same code.

You patch will come in handy when we get to adding support for GNOME 3.

Thanks,
Curtis
Comment 6 Jeremy Bicha 2013-07-22 03:04:31 UTC
Curtis, thanks for the reply.

The cs.po and similar updates were because as of gnome-desktop 3.5.5, help:fdl is a valid link to a copy of the GFDL and ghelp:fdl no longer works. You're going to have to pick whether you want the latest GParted to work out of the box on current distros or work on older distros. Since most people get GParted from their distro or from GParted Live, working on current distros is what I strongly recommend.

I could split the help:fdl changes to a separate patch but it shouldn't really affect translators.

I think I can update my patch to use yelp-tools and modern help install directories if available and fall back to gnome-doc-utils and Yelp 2 compatible install directories if not.
Comment 7 Curtis Gedak 2013-07-22 15:07:40 UTC
Hi Jeremy,

> Since most people get GParted from their distro or from GParted Live,
> working on current distros is what I strongly recommend.

I agree with your logic here.  Fortunately all the current distros still package gnome 2 libraries (specifically libgtkmm-2.4) which is required by GParted.  I think this library will be around at least until gimp has a chance to migrate to gtk 3.x which is planned for gimp version 3.0.  See,

http://wiki.gimp.org/index.php/Roadmap


> I could split the help:fdl changes to a separate patch but it shouldn't
> really affect translators.

I think it would help if you could split the help:fdl changes into a separate patch for the translated files.  My reasoning is that the more files touched by a patch, the more likely the patch will fail to apply as the code base evolves.

> I think I can update my patch to use yelp-tools and modern help install
> directories if available and fall back to gnome-doc-utils and Yelp 2
> compatible install directories if not.

This idea sounds like a good improvement to me.  :-)

Curtis
Comment 8 Jeremy Bicha 2013-08-01 02:34:32 UTC
Created attachment 250576 [details] [review]
Fix help link for gnome-desktop 3.5+

I generated this by running
find ./ -type f -exec sed -i 's/ghelp:fdl/help:fdl/g' {} \;

By updating the translations at the same time, it should be
easier on the translators as there's no reason to invalidate these strings
Comment 9 Curtis Gedak 2013-08-01 15:26:26 UTC
Hi Jeremy,

Thank you for creating a separate patch for the "ghelp" --> "help" translation change.

In viewing the patch I did not observe the section for updating Makefile.am, configure.ac, etc as was part of the original patches in comment #1 and comment #2.  A separate patch for this would be appreciated as well.

Thanks,
Curtis
Comment 10 Mike Fleetwood 2019-03-01 20:33:38 UTC
GParted has been switched from gnome-doc-utils to yelp-tools and
Jeremy's patch from comment 8 was updated and included as part of that
change.  These changes will be included in the next release of GParted.

Port to GNOME 3 yelp-tools documentation infrastructure
https://gitlab.gnome.org/GNOME/gparted/merge_requests/24

Fix FDL help link for gnome-desktop 3.5+ (!24)
https://gitlab.gnome.org/GNOME/gparted/commit/12adade3ab6b12fdf20af1f67de5a2a5ba2f5882
Comment 11 Mike Fleetwood 2019-06-26 09:25:30 UTC
This enhancement was included in the GParted 1.0.0 release on May 29, 2019.