Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 667914 - app-text/xiphos - stop using gtkhtml
Summary: app-text/xiphos - stop using gtkhtml
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Marek Szuba (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on: 855008
Blocks:
  Show dependency tree
 
Reported: 2018-10-06 21:49 UTC by Mart Raudsepp
Modified: 2022-06-30 09:11 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Mart Raudsepp gentoo-dev 2018-10-06 21:49:53 UTC
gtkhtml is deprecated and we want to last rite it. xiphos is the last remaining consumer of it.

I see that at least xiphos-4.1.0 (maybe earlier) also supports fully webkit-gtk based build, by passing --enable-webkit-editor to configure. Please check if that gets rid of the gtkhtml and is sufficiently good (no feature regressions over gtkhtml in the editor, etc) and switch to it if it's fine.
Comment 1 Chris Reffett (RETIRED) gentoo-dev Security 2018-10-08 23:45:44 UTC
It does not work as a replacement right now unless you want to bring back webkit-gtk:3. Looks like they haven't ported it to newer webkit-gtk:4/gtk+-3 yet.

Upstream issue: https://github.com/crosswire/xiphos/issues/794
Comment 2 Marek Szuba (RETIRED) archtester gentoo-dev 2020-07-27 17:55:12 UTC
Still no go as of 4.2.1... There is hope, though - according to https://github.com/crosswire/xiphos/issues/957#issuecomment-615898431 there might be a new editor available in not-so-distant future.
Comment 3 Mart Raudsepp gentoo-dev 2020-07-29 21:27:36 UTC
Why not use the WebKit editor?

The one from this branch in cmake/XiphosDependencies.cmake:

  if (NOT WEBKIT1 AND NOT GTKHTML)
    # Gtk+-3.0 + Webkit2 + GtkHtml-editor
     pkg_check_modules(Gtk REQUIRED IMPORTED_TARGET
      "gtk+-3.0"
      "webkit2gtk-4.0"
      )
  endif()
Comment 4 Marek Szuba (RETIRED) archtester gentoo-dev 2020-07-29 21:37:08 UTC
Because it doesn't build against net-libs/webkit-gtk:4. So far, the way other distros have dealt with this is disable the editor functionality altogether.
Comment 5 Larry the Git Cow gentoo-dev 2020-07-30 11:18:40 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=eda4104d25ede56b6a3924dd6a68f6545440769a

commit eda4104d25ede56b6a3924dd6a68f6545440769a
Author:     Marek Szuba <marecki@gentoo.org>
AuthorDate: 2020-07-30 10:44:17 +0000
Commit:     Marek Szuba <marecki@gentoo.org>
CommitDate: 2020-07-30 11:18:04 +0000

    gnome-extra/gtkhtml: take over maintenance
    
    gtkhtml is deprecated and our Gnome project would like to get rid of it,
    unfortunately without it app-text/xiphos has to be built without editor
    support (which is the way e.g. Debian, Ubuntu and Red Hat have gone) and
    from what I have seen many people are unhappy about the inability to use
    the Studypad or make personal annotations. Xiphos is now the only
    remaining consumer of this library so I shall maintain it between now
    and until upstream have implemented a working alternative (apparently
    they began to discuss it back in April), after which it will be
    last-rited.
    
    Discussed with and approved by leio on IRC.
    
    Bug: https://bugs.gentoo.org/667914
    Signed-off-by: Marek Szuba <marecki@gentoo.org>

 gnome-extra/gtkhtml/metadata.xml | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)
Comment 6 Marek Szuba (RETIRED) archtester gentoo-dev 2020-07-30 11:25:35 UTC
OK, this is now a semi-private dependency of app-text/xiphos which will be last-rited as soon as upstream have implemented a working alternative. They began discussing it back in April so hopefully it won't be much longer.
Comment 7 Matt Turner gentoo-dev 2022-05-18 02:05:41 UTC
(In reply to Marek Szuba from comment #4)
> Because it doesn't build against net-libs/webkit-gtk:4. So far, the way
> other distros have dealt with this is disable the editor functionality
> altogether.

I see that xiphos has a dependency on net-libs/webkit-gtk:4. Is that dependency used and correct? I'm confused.
Comment 8 Marek Szuba (RETIRED) archtester gentoo-dev 2022-05-18 09:41:13 UTC
(In reply to Matt Turner from comment #7)

> I see that xiphos has a dependency on net-libs/webkit-gtk:4. Is that
> dependency used and correct? I'm confused.

It is a correct dependency that xiphos build scripts enforce at build time. See lines 134-142 of src/XiphosDependencies.cmake.
Comment 9 Mart Raudsepp gentoo-dev 2022-05-18 11:16:15 UTC
But we need a resolution from Gentoo side that isn't just "RESOLVED UPSTREAM".
And it has a configuration combination that uses webkit-gtk:4 and does NOT use gtkhtml, I quoted that in comment #3. You are saying that while it's there, it doesn't actually build or work?
Comment 10 Mart Raudsepp gentoo-dev 2022-05-18 11:19:36 UTC
What I mean is, it actually looks for the pkg-config file of webkit-gtk:4 - that's just an error from upstream in assuming it'd work but actually needs porting?
Comment 11 Marek Szuba (RETIRED) archtester gentoo-dev 2022-05-18 11:29:07 UTC
(In reply to Mart Raudsepp from comment #9)

> But we need a resolution from Gentoo side that isn't just "RESOLVED
> UPSTREAM".

Well, given what upstream has been saying about the editor ("it has been giving us grief for 15 years" to quote just one statement) and that they still haven't made any significant progress in addressing this (which was the main rationale for RESOLVED UPSTREAM), I guess we might as well follow the example of other distros and disable the editor... The fallout ought to be fairly minimal (it will no longer be possible to make own notes in Xiphos but that's about it), and looking at the final comments in the linked upstream issue they are now officially planning to make the editor component optional.

WDYT?

> And it has a configuration combination that uses webkit-gtk:4 and does NOT
> use gtkhtml, I quoted that in comment #3. You are saying that while it's
> there, it doesn't actually build or work?

Correct, it doesn't build. Not that it's exactly surprising, they do in fact warn about "NOT WEBKIT1 AND NOT GTKHTML" being a work-in-progress configuration in the final lines of cmake/XiphosReport.cmake.
Comment 12 Mart Raudsepp gentoo-dev 2022-05-18 11:35:37 UTC
I think the motivation is to last-rite gtkhtml as unmaintained upstream, BUT now I realize you just took that over as maintainer instead already and I forgot, so actually just do what you want. I forgot that had happened and Matt was poking here for being able to last rite it from under gnome@ or so
Comment 13 Mart Raudsepp gentoo-dev 2022-05-18 11:36:48 UTC
The confusing thing is why it uses gtkhtml editor, but then still links to webkit-gtk:4 as well, as per comment #7
Comment 14 Matt Turner gentoo-dev 2022-05-18 16:12:25 UTC
Yeah, I was just going through the list of deprecated gnome@-maintained packages and checking on reverse dependencies. I checked the build system and saw that WebKit was an alternative to gtkhtml, and then was confused why we were depending on both.

I'm not demanding we remove gtkhtml or anything of the sort, but it would be good to leave the bug open since we ultimately do want to remove gtkhtml.
Comment 15 Larry the Git Cow gentoo-dev 2022-05-29 22:07:41 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=e53ce62d98b7c4033da6850b3f62fc5a371825a5

commit e53ce62d98b7c4033da6850b3f62fc5a371825a5
Author:     Marek Szuba <marecki@gentoo.org>
AuthorDate: 2022-05-29 09:22:34 +0000
Commit:     Marek Szuba <marecki@gentoo.org>
CommitDate: 2022-05-29 22:07:32 +0000

    app-text/xiphos: disable the editor
    
    The editor still requires either WebKit1 or GtkHTML, and upstream hasn't
    made much progress on this in recent years (yes, years). Many other
    distros have had the editor disabled for quite a while now (many thanks
    to Debian for the patch we now use) and since upstream activity implies
    they will make the editor officially optional soon, let's do the same.
    
    Once this version has been stabilised we will finally be able to get rid
    of gnome-extra/gtkhtml.
    
    Bug: https://bugs.gentoo.org/667914
    Signed-off-by: Marek Szuba <marecki@gentoo.org>

 app-text/xiphos/Manifest               |  1 +
 app-text/xiphos/xiphos-4.2.1-r1.ebuild | 72 ++++++++++++++++++++++++++++++++++
 2 files changed, 73 insertions(+)
Comment 16 Larry the Git Cow gentoo-dev 2022-06-30 09:02:00 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=afac1af1f7b322179f046dade14e7e13235bd399

commit afac1af1f7b322179f046dade14e7e13235bd399
Author:     Marek Szuba <marecki@gentoo.org>
AuthorDate: 2022-06-30 08:13:34 +0000
Commit:     Marek Szuba <marecki@gentoo.org>
CommitDate: 2022-06-30 09:01:47 +0000

    app-text/xiphos: drop 4.2.1
    
    This removes the last gnome-extra/gtkhtml revdep from the tree.
    
    Bug: https://bugs.gentoo.org/667914
    Signed-off-by: Marek Szuba <marecki@gentoo.org>

 app-text/xiphos/xiphos-4.2.1.ebuild | 64 -------------------------------------
 1 file changed, 64 deletions(-)