Bug 1217886 - pipewire generates corrupted documentation with doxygen < 1.9.7
Summary: pipewire generates corrupted documentation with doxygen < 1.9.7
Status: RESOLVED FIXED
Alias: None
Product: openSUSE.org
Classification: openSUSE
Component: 3rd party software (show other bugs)
Version: unspecified
Hardware: Other Other
: P5 - None : Normal (vote)
Target Milestone: ---
Assignee: Antonio Larrosa
QA Contact: E-mail List
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-12-07 15:47 UTC by pallas wept
Modified: 2024-02-21 07:40 UTC (History)
1 user (show)

See Also:
Found By: ---
Services Priority:
Business Priority:
Blocker: ---
Marketing QA Status: ---
IT Deployment: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description pallas wept 2023-12-07 15:47:23 UTC
To quote the pipewire dev who wrote the patches:
> This will need Doxygen 1.9.7, earlier versions put .md files in wrong place in HTML treeview because of https://github.com/doxygen/doxygen/issues/9254

The pipewire package is presently using doxygen 1.9.6, so is generating corrupt docs. 

Doxygen can't be updated because wxPython is broken on new versions, so wxPython needs to be fixed, so that doxygen can be updated, so that pipewire generates docs correctly. See https://build.opensuse.org/request/show/1128250

Sorry to be the bearer of bad news.
Comment 1 Christoph G 2023-12-25 19:53:56 UTC
Is there an upstream issue open for wxPython? Doxygen 1.10 was released!
Comment 2 Christoph G 2023-12-25 21:11:58 UTC
Fixed in wxPython, see https://github.com/wxWidgets/Phoenix/pull/2497
This commit has to be added to our wxPython package as a patch.
Comment 3 pallas wept 2023-12-26 12:15:10 UTC
(In reply to Christoph G from comment #1)
> Is there an upstream issue open for wxPython? Doxygen 1.10 was released!

As far as I'm aware, nobody from opensuse has chased this up with them yet. I brought it up on OBS and got no replies, so that's why I created this issue, and I've had no replies here, either.
Comment 4 pallas wept 2023-12-26 12:22:53 UTC
(In reply to Christoph G from comment #2)
> Fixed in wxPython, see https://github.com/wxWidgets/Phoenix/pull/2497
> This commit has to be added to our wxPython package as a patch.

But perhaps this was an opensuse contributor helping out? I guess we will just have to wait and see if opensuse pick it up, or maybe we'll have to wait for the next wxWidgets release for the next doxygen release so we can have fully working pipewire. Until then I'm building doxygen and pipewire in my home repo so that my doco works, which isn't great....

I wish someone from opensuse would say something to us. I feel like a mushroom :D
Comment 5 Antonio Larrosa 2023-12-26 13:00:41 UTC
    Thanks Pallas and Christoph for taking care of this. I submitted the wxPython fix (and a couple other fixes) in https://build.opensuse.org/request/show/1135151 and there's already https://build.opensuse.org/request/show/1135120 that submits a doxygen update. So let's see if those get approved soon.
Comment 6 pallas wept 2023-12-26 13:09:41 UTC
(In reply to Antonio Larrosa from comment #5)
>     Thanks Pallas and Christoph for taking care of this. I submitted the
> wxPython fix (and a couple other fixes) in
> https://build.opensuse.org/request/show/1135151 and there's already
> https://build.opensuse.org/request/show/1135120 that submits a doxygen
> update. So let's see if those get approved soon.

Ahh legendary, thanks Antonio! All credit for taking care of it goes to you and Christoph, here, I didn't know about the patch! Much appreciated thanks to you both :)
Comment 7 pallas wept 2024-01-04 08:08:13 UTC
doxygen is 1.10 now, so this can me closed, the next pipewire release's doc should be fine.

Great work Antonio and Christoph, thanks so much!