Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
sezero opened this issue Aug 9, 2023 · 9 comments
Closed

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

sezero opened this issue Aug 9, 2023 · 9 comments

Comments

@sezero
Copy link
Contributor

sezero commented Aug 9, 2023

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

@slouken
Copy link
Collaborator

slouken commented Aug 9, 2023

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

Any volunteers?

@madebr
Copy link
Contributor

madebr commented Aug 9, 2023

These are caused by this line:

warn_about_missing = 1

It is set to 0 in SDL, but to 1 in the satellite libraries.

I asked here: libsdl-org/SDL#7514 (comment) (but I don't think it got answered)

@madebr
Copy link
Contributor

madebr commented Aug 9, 2023

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
Copy link
Collaborator

slouken commented Aug 9, 2023

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

@madebr
Copy link
Contributor

madebr commented Aug 9, 2023

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
Copy link
Contributor Author

sezero commented Sep 6, 2023

#552 seems to have fixed this.

@sezero sezero closed this as completed Sep 6, 2023
@madebr
Copy link
Contributor

madebr commented Sep 6, 2023

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 😛

@sezero
Copy link
Contributor Author

sezero commented Sep 6, 2023

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

@madebr
Copy link
Contributor

madebr commented Sep 6, 2023

The manpage generation is for SDL3 only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants