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 518384 - libsoup-2.2.105 and 2.3.x API documentation does not work in devhelp
libsoup-2.2.105 and 2.3.x API documentation does not work in devhelp
Status: RESOLVED FIXED
Product: libsoup
Classification: Core
Component: Misc
2.2.x
Other Linux
: Normal normal
: ---
Assigned To: libsoup-maint@gnome.bugs
libsoup-maint@gnome.bugs
Depends on:
Blocks:
 
 
Reported: 2008-02-24 10:14 UTC by Mart Raudsepp
Modified: 2008-02-25 19:28 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Patch made after gtksourceview-2.0 approach (2.31 KB, patch)
2008-02-24 11:32 UTC, Mart Raudsepp
none Details | Review

Description Mart Raudsepp 2008-02-24 10:14:21 UTC
libsoup-2.2.105 got its API documentation moved to libsoup-2.2 namespace, to have it the same as libsoup-2.4 was version namespace per bug 512810.
However, this does not work properly for devhelp, as devhelp is looking for devhelp files that are named per the directory name, so it's looking for /usr/share/gtk-doc/libsoup-2.2/libsoup-2.2.devhelp, while it's named libsoup.devhelp and therefore libsoup documentation is not searchable/browseable in devhelp-1.8.

The devhelp file names should be versioned as well.

I don't know if libsoup-2.4 is affected by this as well or not
Comment 1 Mart Raudsepp 2008-02-24 11:32:14 UTC
Created attachment 105856 [details] [review]
Patch made after gtksourceview-2.0 approach

First stab at a patch to fix this, designed after gtksourceview-2.0 approach.
In addition the devhelp files need to be renamed in docs/reference/html after applying the patch (svn mv to retain history) - libsoup.devhelp -> libsoup-2.2.devhelp  libsoup.devhelp2 -> libsoup-2.2.devhelp2
Comment 2 Mart Raudsepp 2008-02-24 11:33:58 UTC
Just rename of the devhelp files makes it work as well in devhelp-0.18 (wrongly states as 1.8 above), but to be sure the patch does what gtksourceview-2.0 does to avoid the override and have different devhelp names as well.

I'd appreciate a 2.2.106 release with this bug fixed, as 2.2.105 has this bug (which I consider a serious regression), but together with a code bug fix
Comment 3 Mart Raudsepp 2008-02-24 12:04:09 UTC
libsoup-2.3.2 does the PATH override without *.devhelp* file renames as well, so I'm pretty sure 2.3.x is broken as well for devhelp
Comment 4 Mart Raudsepp 2008-02-24 12:19:21 UTC
(In reply to comment #1)
> In addition the devhelp files need to be renamed in docs/reference/html after
> applying the patch (svn mv to retain history) - libsoup.devhelp ->
> libsoup-2.2.devhelp  libsoup.devhelp2 -> libsoup-2.2.devhelp2

Of course these are generated files (as I realized now), so I assume these will simply be generated with the correct name after DOC_MODULE has been patched to contain the version number
Comment 5 Dan Winship 2008-02-25 19:28:11 UTC
Fixed for 2.3.x. I'm not going to put out a 2.2.106 release just for this; no one should be looking at the 2.2 docs at this point anyway, and if they really need to, they're online.