Enforce required cmake flags as explicit requirements #11457
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jathu
added
module: build/install
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/11457
Note: Links to docs will display an error until the docs builds have been completed. ⏳ No Failures, 1 PendingAs of commit 16b18b2 with merge base 8f05c35 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
jathu
changed the title
jathu
force-pushed
the
jathu/cmake-explicit-flag-requires
branch
from
e3fba22 to
60fa340
Compare
jathu
force-pushed
the
jathu/cmake-explicit-flag-requires
branch
from
60fa340 to
469e165
Compare
jathu
force-pushed
the
jathu/cmake-required-flags
branch
from
28bcb5d to
e8aec99
Compare
jathu
force-pushed
the
jathu/cmake-explicit-flag-requires
branch
2 times, most recently
from
ac1180e to
e23f1cc
Compare
jathu
requested review from
larryliu0820,
kirklandsign and
cccclai
as code owners
jathu
force-pushed
the
jathu/cmake-explicit-flag-requires
branch
from
e23f1cc to
9e19d27
Compare
larryliu0820
reviewed
Jun 6, 2025
larryliu0820
reviewed
Jun 6, 2025
larryliu0820
reviewed
Jun 6, 2025
larryliu0820
approved these changes
Jun 6, 2025
jathu
force-pushed
the
jathu/cmake-explicit-flag-requires
branch
from
9e19d27 to
02e8f57
Compare
jathu
added a commit
that referenced
this pull request
Jun 6, 2025
### Summary Some flags require other flags to also be turned on. So this function helps use enforce it. ### Test plan Used in: #11457 ``` $ python -m unittest tools.cmake.common.preset_test.TestPreset ``` cc @larryliu0820
jathu
force-pushed
the
jathu/cmake-explicit-flag-requires
branch
3 times, most recently
from
ce72c8c to
86602c7
Compare
jathu
force-pushed
the
jathu/cmake-explicit-flag-requires
branch
from
86602c7 to
d189a21
Compare
jathu
force-pushed
the
jathu/cmake-explicit-flag-requires
branch
from
d189a21 to
16b18b2
Compare
jathu
added a commit
that referenced
this pull request
Jun 10, 2025
### Summary Similar to #11457, but now we also want to warn against unsupported/conflicting flags. For example, when using `EXECUTORCH_BUILD_ARM_BAREMETAL`, we cannot enable certain flags. ### Test plan CI ``` $ cmake -DEXECUTORCH_BUILD_ARM_BAREMETAL=ON --preset macos CMake Error at tools/cmake/common/preset.cmake:142 (message): Both 'EXECUTORCH_BUILD_ARM_BAREMETAL' and 'EXECUTORCH_BUILD_EXTENSION_DATA_LOADER' can't be ON Call Stack (most recent call first): tools/cmake/preset/default.cmake:352 (check_conflicting_options_on) CMakeLists.txt:87 (include) ``` cc @larryliu0820 @digantdesai @freddan80 @per @zingo @oscarandersson8218
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The build file currently turns on a bunch of implicitly dependent flags, perhaps unnecessarily. Let's make these dependencies explicit now.
For example, previously if
EXECUTORCH_BUILD_EXTENSION_TRAININGwas turned on, it would then turn on its own set of dependencies. This is good from a developer experience point of view because users would need to just turn on one flag. However, from a build point of view, it makes it harder to maintain and understand what flags are conflicting with one another. Now, if you want to build the training extension, you will have to explicitly turn on the required flags. However, with our build presets — most developers should not have to do to this!I have created a follow up ticket to actually comb through the existing flags and trim the fat if necessary: #11458
Test plan
CI
cc @larryliu0820