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

Change build flags in Godot 4 docs to current variants #6375

Closed
wants to merge 2 commits into from

Conversation

ZoopOTheGoop
Copy link

@ZoopOTheGoop ZoopOTheGoop commented Nov 9, 2022

I was trying to follow the build instructions for production and found that at some point on master the flags in SConstruct had changed - in particular the target values now only include editor, template_release, and template_debug. I made my best guess at the proper ones to use, this probably needs a revision pass by someone who builds Godot from source more often than me.

In particular, I had to remove the documentation for the headless section, as it's not entirely clear from SConstruct what you'd pass to do it. This probably also needs to be changed on the other platforms, but I haven't had the opportunity to check that yet.

Changelog:

  • target=release_debug -> optimize=speed_trace
  • target=release -> optimize=speed (may also need debug_symbols=no?)
  • use production=yes as default option for production builds
  • remove headless compilation as current way to do this is non-obvious with current build targets available, should be added before merging

Changelog:
- `target=release_debug` -> `optimize=speed_race`
- `target=release` -> `optimize=speed`
- use `production=yes` as default option for production builds
- remove headless compilation as current way to do this is non-obvious with current build targets available, should be added before merging
Also uses right LTO flag
@ZoopOTheGoop
Copy link
Author

ZoopOTheGoop commented Nov 10, 2022

NB: seems to complement #6316, which gets some of the other changes I mentioned but didn't figure out wrt headless builds etc. However, that PR does not seem to cover the production optimization flag changes.

@Calinou Calinou added the bug label Nov 10, 2022

.. note:: If you want to use separate editor settings for your own Godot builds
and official releases, you can enable
:ref:`doc_data_paths_self_contained_mode` by creating a file called
``._sc_`` or ``_sc_`` in the ``bin/`` folder.

Compiling a headless/server build
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this functionality removed?
Can't find anything in the original PR: godotengine/godot#66242

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I mentioned in the original post, I couldn't find how to do this, so I removed it so as not to give bad instructions. I'll probably revert this because another PR seems to fix the headless build instructions.

@YuriSizov
Copy link
Contributor

#6316 has been merged, so this needs a rebase, if there is still some information worth adding, or we should close this if there isn't anything.

@YuriSizov YuriSizov added area:contributing Issues and PRs related to the Contributing/Development section of the documentation topic:buildsystem labels Dec 28, 2022
@Vennnot
Copy link
Contributor

Vennnot commented May 3, 2023

I think this should be closed. If the creator thinks there is still information to be added we can re-open.

@mhilbrunner
Copy link
Member

Closing as per the above discussion. Please ping for a reopen if there is still important information to add to the current page, in which case this PR needs to be updated/rebased - or open a new one. Thanks for contributing!

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

Successfully merging this pull request may close these issues.

6 participants