search

libsdl-org / SDL_mixer

An audio mixer that supports various file formats for Simple Directmedia Layer.
zlib License
423 stars 144 forks source link

lots of "defined in the headers but not the wiki!" warnings #542

Closed sezero closed 1 year ago

sezero commented 1 year ago

E.g.: WARNING: Mix_AllocateChannels defined in the headers but not the wiki! Seen in the CI logs too.

slouken commented 1 year ago

I think we need someone to go through and update the wiki with all of our changes.

Any volunteers?

madebr commented 1 year ago

These are caused by this line: https://github.com/libsdl-org/SDL_mixer/blob/14f1eb25603cc75624e9d2c92a5b0eebcf93a015/.wikiheaders-options#L15 It is set to 0 in SDL, but to 1 in the satellite libraries.

I asked here: https://github.com/libsdl-org/SDL/issues/7514#issuecomment-1608560156 (but I don't think it got answered)

madebr commented 1 year ago

I think we need someone to go through and update the wiki with all of our changes.

Any volunteers?

The manpage generator script always generates the wiki/man pages from scratch. So when first generating the docs, all pages are guaranteed to be missing.

slouken commented 1 year ago

Oh, okay. So is it fine just to remove the warning?

madebr commented 1 year ago

I think the warning makes sense when updating the sdl wiki, but not when generating the man pages. So perhaps it should be changed into a cli argument-only option.

sezero commented 1 year ago

https://github.com/libsdl-org/SDL_mixer/pull/552 seems to have fixed this.

madebr commented 1 year ago

I applied the same fix for the main branches of the other satellite libraries. I left SDL2 alone. So for the mean time, ryan will keep getting spammed :stuck_out_tongue:

sezero commented 1 year ago

BTW, the SDL2 branch has the same warn_about_missing = 1 but I don't remember getting the warnings.

madebr commented 1 year ago

The manpage generation is for SDL3 only.