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

Add dev_build and dev_mode flags to SCons compilation instructions for desktop editor pages #10019

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

jonathansekela
Copy link

@jonathansekela jonathansekela commented Sep 29, 2024

This is for Issue #10018.

Add instructions to compile SCons with dev_build=yes and dev_mode=yes flags to desktop documentation pages.

@AThousandShips AThousandShips added area:contributing Issues and PRs related to the Contributing/Development section of the documentation topic:buildsystem cherrypick:4.2 cherrypick:4.3 labels Sep 29, 2024
@jonathansekela
Copy link
Author

For @bruvzg 's mention on The dev_build parameter being the specific one making sure the debug symbols are included and dev_mode doing something slightly different, I'm assuming I should modify the documentation to reflect what each parameter does specifically?

@jonathansekela
Copy link
Author

Alternatively, I could just put a link to the Introduction page's development and production aliases headline: https://docs.godotengine.org/en/stable/contributing/development/compiling/introduction_to_the_buildsystem.html#development-and-production-aliases

This entire PR stems from the idea that many first-time contributors skip the Introduction documentation and go directly to their personal platform's installation instructions. Any ideas on the best way to give them the information they need as unobtrusively as possible?

@bruvzg
Copy link
Member

bruvzg commented Sep 29, 2024

Alternatively, I could just put a link to the Introduction page's development and production aliases headline

This probably is a better option, and will avoid unnecessary duplication of the same info on multiple pages. use breakpoints while developing feels too broad and does not mention any negative effects. Most users probably do not want to use it, since disabling optimizations make the engine a lot slower.

@tetrapod00
Copy link
Contributor

tetrapod00 commented Sep 29, 2024

What about another tip or note box, just before or after the one about the one about production=yes?

Tip
If you are compiling Godot to make changes or contribute to the engine, you may want to use the SCons options dev_build=yes or dev_mode=yes. See https://docs.godotengine.org/en/stable/contributing/development/compiling/introduction_to_the_buildsystem.html#development-and-production-aliases for more info.

(The section for dev_build is immediately after the linked section, so just the one link should suffice.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation cherrypick:4.2 cherrypick:4.3 topic:buildsystem
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants