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 760313 - Make it possible to install additional docs from devhelp itself
Make it possible to install additional docs from devhelp itself
Status: RESOLVED DUPLICATE of bug 761284
Product: devhelp
Classification: Applications
Component: General
3.18.x
Other Linux
: Normal enhancement
: ---
Assigned To: devhelp-maint
devhelp-maint
Depends on:
Blocks:
 
 
Reported: 2016-01-08 10:19 UTC by Jonathan Kang
Modified: 2017-06-29 11:48 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Add-ons for Firefox in Gnome-Software (161.88 KB, image/png)
2016-01-08 10:19 UTC, Jonathan Kang
Details

Description Jonathan Kang 2016-01-08 10:19:16 UTC
Created attachment 318473 [details]
Add-ons for Firefox in Gnome-Software

OS: Fedora 23
HW: HP ProBook 4740s

I did a fresh installation of Fedora 23, and installed Devhelp 3.18.1 using "dnf install devhelp". Once I opened Devhelp the first time, I found that many APIs are missing. For example, APIs about Gtk+, GLib, etc. Later on, I asked for David's found that I should install some packages like gtk3-devel-docs and gtk-doc to get those APIs available in Devhelp.

So I'm thinking a way to improve this(some ideas from David King).

I think Devhelp should recommend users those packages that may be needed by itself. For example, in Gnome-Software, add a "Add-ons" section to recommend those docs packages(as shown in the attached picture). If users are installing Devhelp using command line, maybe devhelp can recommend those documentation packages.

That way, it would be better so that some users like me will not google it or ask someone else for help. It would be a very nice improvement, in my opinion.
Comment 1 Frederic Peters 2016-01-08 10:22:58 UTC
This looks like a request for the Fedora package, for example the Debian package already has this line:

Recommends: libgtk-3-doc, libglib2.0-doc, libpango1.0-doc

Could you file it in the Fedora bugzilla?  (bugzilla.redhat.com, product: Fedora, component: devhelp)
Comment 2 Jonathan Kang 2016-01-08 14:25:13 UTC
(In reply to Frederic Peters from comment #1)
> This looks like a request for the Fedora package, for example the Debian
> package already has this line:
> 
> Recommends: libgtk-3-doc, libglib2.0-doc, libpango1.0-doc
> 
> Could you file it in the Fedora bugzilla?  (bugzilla.redhat.com, product:
> Fedora, component: devhelp)

Thanks for the information. I'll file a bug in the Fedora bugzilla.
Comment 3 Debarshi Ray 2016-01-15 12:34:58 UTC
(In reply to Frederic Peters from comment #1)
> This looks like a request for the Fedora package, for example the Debian
> package already has this line:
> 
> Recommends: libgtk-3-doc, libglib2.0-doc, libpango1.0-doc

I don't think we can expect downstream packagers of all distributions to maintain the list of all packages that might be shipping gtk-doc documentation. eg., that list doesn't include clutter-doc and webkitgtk4-doc. :)

Instead, I would expect devhelp to look at all the libraries installed on my system and offer to install the documentation for those, if they are missing. Maybe we can achieve something like this using PackageKit and gnome-software?
Comment 4 Sébastien Wilmet 2016-01-29 12:32:10 UTC
Instead of taking the docs from the distro, it's probably a better idea to download the latest versions, see bug #761284.
Comment 5 Sébastien Wilmet 2017-06-29 11:48:12 UTC
(In reply to Sébastien Wilmet from comment #4)
> Instead of taking the docs from the distro, it's probably a better idea to
> download the latest versions, see bug #761284.

So as a first step to improve the situation, I think it would be a good idea to implement bug #761284. Once it is done, we'll see what can be done for non-gnome libraries.

*** This bug has been marked as a duplicate of bug 761284 ***