Skip to content

Conversation

@YuriSizov
Copy link
Contributor

Based on some discussions on RocketChat we've identified that some of the buildsystem documentation may be lacking in terms of introductory sections. So I've added an intro section to the Introduction to the buildsystem and also the its parent Building from source article. (cc @anvilfolk)

I also tries to improve the navigation a bit, by grouping related articles in the Engine development and Building from source articles. With all the changes it looks like this:

chrome_2023-10-03_14-42-56 chrome_2023-10-03_14-42-38 chrome_2023-10-03_14-42-12

And also attempt to improve navigation of the engine
development section of the contribution docs.
@YuriSizov YuriSizov added enhancement area:engine details Issues and PRs related to the Engine Details section of the documentation topic:buildsystem cherrypick:4.1 labels Oct 3, 2023
@YuriSizov YuriSizov added this to the 4.2 milestone Oct 3, 2023
@nlupugla
Copy link

nlupugla commented Oct 3, 2023

It'd be great if you could also suggest dev_mode=yes or whatever the syntax is for the preset that generates debug symbols and tests.

@nlupugla
Copy link

nlupugla commented Oct 3, 2023

Related: would it be worth having a sort of "cheat sheet" and/or "FAQ" page? For example, compiledb=yes or scu are commands that can be super helpful, but are easy to miss by the time you have 10 tabs open. I know these things are all written in the docs, but it doesn't hurt to repeat important information a few times in different places.

@YuriSizov
Copy link
Contributor Author

It'd be great if you could also suggest dev_mode=yes or whatever the syntax is for the preset that generates debug symbols and tests.

@nlupugla dev_build=yes generates debug symbols, but not tests. That's sufficient to develop the engine (that's what I use). The rest is already explained in the body of the article.

@mhilbrunner mhilbrunner merged commit c0cf109 into godotengine:master Oct 3, 2023
@mhilbrunner
Copy link
Member

Thanks :) Merged!

@YuriSizov YuriSizov deleted the buildsystem-intro branch October 4, 2023 11:33
@mhilbrunner
Copy link
Member

Cherry-picked to 4.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:engine details Issues and PRs related to the Engine Details section of the documentation enhancement topic:buildsystem

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants