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

Move glad into another repository #1323

Closed
RiscadoA opened this issue Sep 24, 2024 · 0 comments · Fixed by #1336
Closed

Move glad into another repository #1323

RiscadoA opened this issue Sep 24, 2024 · 0 comments · Fixed by #1336
Assignees
Labels
A-Core B-Build Related to the build configuration C-Code-Quality A section of code that is hard to understand or change D-Good-First-Issue Easy but interesting
Milestone

Comments

@RiscadoA
Copy link
Member

RiscadoA commented Sep 24, 2024

Problem

Currently glad is a submodule of our repository.
glad is a library whose code must be first generated according to some configurations we set. Only then is it really built and linked into the engine.

The actual problem lies in the glad code generation being implemented in Python, and thus Python becomes a necessary dependency to build Cubos (ew).
The glad team recommends users to simply use their web interface to generate the code, and then include the generated code in our source tree.
That is what we did previously, but we find it ugly to just have external files laying around on our repo like that.

Solution

We should create another repository, cubos-glad or something, where we keep the external files generated with glad's web interface, and the relevant instructions in a README next to it.
We can then add that repo as a submodule to the main engine repo, and thus avoid needing Python to compile everything, while keeping the repo clean.

Extras

We could also do this for header only libraries, such as stb_image. We currently have that file in our engine/lib directory, counting towards our line count and contributor stats, which is a bit odd.
We could also move it to a cubos-stb repo, and then add it as a submodule here.

@RiscadoA RiscadoA added the S-Triage Issues whose priority still has to be figured out label Sep 24, 2024
@RiscadoA RiscadoA changed the title Move GLAD into another Move GLAD into another repository Sep 24, 2024
@RiscadoA RiscadoA added A-Core B-Build Related to the build configuration C-Code-Quality A section of code that is hard to understand or change and removed S-Triage Issues whose priority still has to be figured out labels Sep 24, 2024
@RiscadoA RiscadoA added this to the 0.5 milestone Sep 24, 2024
@RiscadoA RiscadoA changed the title Move GLAD into another repository Move glad into another repository Sep 24, 2024
@RiscadoA RiscadoA added the D-Good-First-Issue Easy but interesting label Sep 24, 2024
@kuukitenshi kuukitenshi linked a pull request Sep 28, 2024 that will close this issue
2 tasks
@RiscadoA RiscadoA modified the milestones: 0.5, 0.4 Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Core B-Build Related to the build configuration C-Code-Quality A section of code that is hard to understand or change D-Good-First-Issue Easy but interesting
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants