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.

Sign up for GitHub

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

Jump to bottom

Print a warning with unknown SCons variables to ease troubleshooting (reverted) #55203

Merged
merged 1 commit into from
Nov 22, 2021
Merged

Print a warning with unknown SCons variables to ease troubleshooting (reverted) #55203

merged 1 commit into from
Nov 22, 2021

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Nov 21, 2021 •
edited
Loading

When disabling specific modules, misspellings can occur. Additionally, when switching between the 3.x and master branches frequently, it's possible to forget about renamed modules such as lightmapper_cpu versus lightmapper_rd.

This was implemented by following the SCons documentation. I tested this change on SCons 4.2.0 and it works as expected.

See #55192.

Preview

❯ scons platform=linuxbsd target=release_debug module_lightmapper_rd_enabled=no module_embree_enabled=no
scons: Reading SConscript files ...
WARNING: Unknown SCons variables were passed and will be ignored:
    module_embree_enabled=no
...

@Calinou
Print a warning with unknown SCons variables to ease troubleshooting
69b2d3f 
When disabling specific modules, misspellings can occur. Additionally,
when switching between the `3.x` and `master` branches frequently,
it's possible to forget about renamed modules such as `lightmapper_cpu`
versus `lightmapper_rd`.
@Calinou Calinou requested a review from a team as a code owner November 21, 2021 16:33
@Calinou Calinou added enhancement topic:buildsystem usability cherrypick:3.4 cherrypick:3.x Considered for cherry-picking into a future 3.x release labels Nov 21, 2021
@Calinou Calinou added this to the 4.0 milestone Nov 21, 2021
@akien-mga akien-mga merged commit 43f53f4 into godotengine:master Nov 22, 2021
@akien-mga
Copy link
Member

Thanks!

@akien-mga akien-mga mentioned this pull request Nov 22, 2021
Open
@Calinou Calinou deleted the scons-warn-unknown-variables branch November 22, 2021 14:34
@Calinou Calinou mentioned this pull request Nov 23, 2021
Merged
@akien-mga
Copy link
Member

akien-mga commented Nov 25, 2021 •
edited
Loading

Cherry-picked for 3.5.

Edit: Reverted prior to the release.

@akien-mga akien-mga removed the cherrypick:3.x Considered for cherry-picking into a future 3.x release label Nov 25, 2021
@akien-mga
Copy link
Member

akien-mga commented Nov 25, 2021 •
edited
Loading

Cherry-picked for 3.4.1.

Edit: Reverted prior to the release.

@akien-mga
Copy link
Member

akien-mga commented Dec 8, 2021 •
edited
Loading

I reverted the cherry-picks for 3.x and 3.4 as discussed in #55698, as this triggers false positives for module-defined options.

The change is still included in master though so that we can improve it further.

Edit: Also reverted in master eventually with #56551.

This was referenced Dec 30, 2021
Closed
Closed
@Calinou Calinou mentioned this pull request Apr 30, 2022
Closed
@akien-mga akien-mga mentioned this pull request Dec 6, 2022
Merged
@akien-mga akien-mga changed the title Print a warning with unknown SCons variables to ease troubleshooting Print a warning with unknown SCons variables to ease troubleshooting (reverted) Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akien-mga akien-mga akien-mga approved these changes

Assignees
No one assigned
Labels
enhancement topic:buildsystem usability
Projects
None yet
Milestone
4.0
Development

Successfully merging this pull request may close these issues.
2 participants
@Calinou @akien-mga