Arch Linux

Please read this before reporting a bug:
https://wiki.archlinux.org/title/Bug_reporting_guidelines

Do NOT report bugs when a package is just outdated, or it is in the AUR. Use the 'flag out of date' link on the package page, or the Mailing List.

REPEAT: Do NOT report bugs for outdated packages!
Tasklist

FS#80026 - [yelp] Need to add yelp to optdepends as many packages require yelp

Attached to Project: Arch Linux
Opened by Stephen A. Engel (garlicbreadwolfs) - Friday, 20 October 2023, 05:15 GMT
Last edited by Toolybird (Toolybird) - Sunday, 29 October 2023, 23:00 GMT
Task Type Bug Report
Category Packages: Extra
Status Closed
Assigned To Jan Alexander Steffens (heftig)
Fabian Bornschein (fabis_cafe)
Architecture All
Severity Very Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Description:
This is not a bug in yelp, but in the PKGBUILD of a number of packages that depend on yelp. It is not a bug in the package itself.

drawing, epiphany, file-roller, gnome-calculator, gnome-screenshot, gucharmap, nemo, rhythmbox, xed, and xreader have GUI help functions. This functionality depends on yelp.
However, these PKGBUILD optdepends do not have yelp; you need to add yelp to optdepends.

Additional info:
* package version(s)
* config and/or log files etc.
* link to upstream bug report, if any

Steps to reproduce:
This task depends upon

Closed by  Toolybird (Toolybird)
Sunday, 29 October 2023, 23:00 GMT
Reason for closing:  Won't fix
Additional comments about closing:  Please see comments
Comment by Toolybird (Toolybird) - Friday, 20 October 2023, 05:21 GMT
Thanks for finding a better way. Opening a zillion repetitive tickets never goes down well :(

As mentioned already, a Package Maintainer Todo List is the best way to handle stuff like this. We'll see what can be done...
Comment by Toolybird (Toolybird) - Friday, 20 October 2023, 20:35 GMT
yelp is a GNOME thing. @heftig, do you have any thoughts on this? The reporter does have a point. When a similar ticket  FS#74877  came up in the past, it was reasoned that any DE should install a help viewer. And it was also mentioned that Plasma's khelpcenter handled the help files just fine, but this no longer works in my quick testing. yelp only gets installed automatically if installing the "gnome" group.
Comment by Fabian Bornschein (fabis_cafe) - Saturday, 21 October 2023, 08:25 GMT
@Toolybird khelpcenter works for me in the way that apps ask to use it, if available. However it doesn't display the actual help files for the specific app. Another thing is 'gnome-user-docs' that also contains some help files for the settings app and nautilus as example, that we'd need to have if we opt-dep to yelp. In general, there are lots of projects involved here, that might depend on yelp [0], like mate.

One thing that also comes to my mind here is Flatpak, but this seems to be covered by the sdk/runtime[1], so maybe this is not a problem on our side.

[0] # pacman -Fyq /usr/share/help/
[1] https://gitlab.gnome.org/GNOME/gnome-build-meta/-/tree/master/elements/sdk
Comment by Jan Alexander Steffens (heftig) - Saturday, 21 October 2023, 10:19 GMT
Yelp is very much a GNOME thing and displays GNOME's help by default. I'm not sure it makes sense to add it to non-GNOME packages just because they install help files.

Is khelpcenter really our only other option, and it's broken?
Comment by Toolybird (Toolybird) - Saturday, 21 October 2023, 21:34 GMT
Sorry, the khelpcenter thing is kinda tangential.

The crux of the issue is that the mentioned apps don't display the GUI help unless yelp is installed. This fits the criteria for an optdep. Of the mentioned apps:

Core GNOME apps-> epiphany, gnome-calculator
Extra GNOME apps-> file-roller
Gnome'ish apps-> drawing, gnome-screenshot, gucharmap, rhythmbox
Cinnamon apps-> nemo, xed, xreader

There's likely a whole bunch of others too...which is why I shut down the mass ticket onslaught. If the consensus is that these apps should have the yelp optdep, I was thinking a PM initiated Todo list could be on the cards (hint, hint :) But if not, it's only a relatively minor issue anyway and we could just not worry about it i.e. "Won't fix".
Comment by Toolybird (Toolybird) - Saturday, 21 October 2023, 21:39 GMT
PS - We could always treat it similar to man pages help. i.e. We don't optdep on "man" for every pkg that provides a man page :)
Comment by Fabian Bornschein (fabis_cafe) - Sunday, 22 October 2023, 10:13 GMT
Ubuntu Mate and Linux Mint do use yelp. So apps of both projects might be good to go with the opt-dep to yelp.

# Note: *Some* of Cinnamon apps (I found nemo) will open the browser to go to the online documentation, on linux mint, while will (try to) open yelp on other distros.
# Note2: nemo will try to open the help for "help:gnome-help/files" that is part of 'gnome-user-docs' and made for nautilus. So I'm not sure if this will help at all to add an opt-dep here. Caja (mate file manager) would depend on 'mate-user-guide' - this one fits in.
Comment by Toolybird (Toolybird) - Sunday, 29 October 2023, 23:00 GMT
@heftig, @fabis_cafe, thanks for your input. It seems clear there is little support for the idea. Therefore as mentioned above, I'm treating this issue as equivalent to the man pages situation i.e. if someone needs to view help files, they simply need to install a help viewer. Someone who cares enough should add a note to the Wiki.

Loading...