Bug 2052721

Summary:	backport fix to set title also when the class structure is opaque [for NetworkManager]
Product:	Red Hat Enterprise Linux 8	Reporter:	Thomas Haller <thaller>
Component:	gtk-doc	Assignee:	David King <dking>
Status:	CLOSED ERRATA	QA Contact:	Tomas Pelka <tpelka>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	8.6	CC:	dking, till, tpelka, tpopela
Target Milestone:	rc	Keywords:	Triaged
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	gtk-doc-1.28-4.el8	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2022-11-08 10:56:57 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	1995915

Description Thomas Haller 2022-02-09 21:04:17 UTC

rhel-8.6 currently ships gtk-doc-1.28-3.el8.

Please backport change https://gitlab.gnome.org/GNOME/gtk-doc/-/merge_requests/2/diffs?commit_id=c8c288ab35f913603fb3f49dd4141aacbd7e8562


NetworkManager needs this, because our public headers (like [2]) only forward declare the GObject typedefs. The effect is, that when building the documentation on rhel-8.6, we have files like

  /usr/share/gtk-doc/html/libnm/libnm-nm-setting-connection.html

when we should have

  /usr/share/gtk-doc/html/libnm/NMSettingConnection.html


you can see that in the build at [3]



In the past this was no problem, because we use the pre-generated documentation from the release tarball. But we would really like to generate the documentation during the package build, because the docs contain value that depend on the configure options (and the way our release tarball is build, differs from our build for rhel).

So this blocks bug https://bugzilla.redhat.com/show_bug.cgi?id=1995915#c14


[2] https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/blob/a1abb3ebdfca0cea16c8649031c9b1b09387b441/src/libnm-core-public/nm-core-types.h#L15
[3] https://brewweb.engineering.redhat.com/brew/buildinfo?buildID=1867463

Comment 1 Thomas Haller 2022-02-09 21:17:18 UTC

I really would like to see this fixed.

But if that's not possible for rhel-8.6, I can also revert the change in NetworkManager, and continue using the pre-generated docs for now.

Just tell me. Thanks.

Comment 2 Till Maas 2022-04-06 18:08:58 UTC

David, could you please provide an estimate when and if this is going to be fixed? Since the patch is developed by my team, we can also do the backport and build for you if you agree. If you don't want to have this change in RHEL 8, please let us know, too, so we can close our dependent bug.

Comment 4 Thomas Haller 2022-04-21 14:40:45 UTC

The build gtk-doc-1.28-4.el8 exists and should fix the problem (from reviewing the package).
But it's still not in the build root.

David, could you please create an errata for 8.7? Thanks.

Comment 5 Tomas Popela 2022-04-21 14:48:09 UTC

(In reply to Thomas Haller from comment #4)
> David, could you please create an errata for 8.7? Thanks.

This is handled by QE -> tpelka, can you look into that?

Comment 6 Tomas Pelka 2022-04-22 06:50:22 UTC

this seems like a bit of chicken and egg problem, so adding verified:tested for now

Comment 11 Thomas Haller 2022-04-28 15:35:32 UTC

I only comment now, because it took me a while to get the build done.

Yes, it's good now. Thank you for the fix!!!

Comment 13 errata-xmlrpc 2022-11-08 10:56:57 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (gtk-doc bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2022:7810