manifest: clarify schema version check with cosmetic renames #909
+16
−11
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
As found in the review of zephyrproject-rtos#904 (migration from pkwalify to jsonschema), the schema version check can be confusing. - Add a couple sentences in MAINTAINERS.rst to clearly state what this version check actually performs and achieves and when (not) to bump the version. - Rename "min_version" to "manifest_version" and swap the perspective "min" and "max" are relative terms, ambiguous when losing track of the point of view. "min_version" stood for "minimum_west_version_needed_to_read_this_manifest". But this is the manifest perspective, which is confusing when reading west code which is the opposite point of view. A given _version_ of west code is never going to change when reading it or running it! So, flip the perspective and look at things from the west point of view when in the west code: rename the also vague _SCHEMA_VER to _MAX_SUPPORTED_SCHEMA_VER. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #909 +/- ##
=======================================
Coverage 85.93% 85.93%
=======================================
Files 11 11
Lines 3455 3455
=======================================
Hits 2969 2969
Misses 486 486
|
pdgendt
approved these changes
Jan 26, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
As found in the review of #904 (migration from pkwalify to jsonschema), the schema version check can be confusing.
Add a couple sentences in MAINTAINERS.rst to clearly state what this version check actually performs and achieves and when (not) to bump the version.
Rename "min_version" to "manifest_version" and swap the perspective
"min" and "max" are relative terms, ambiguous when losing track of the point of view. "min_version" stood for
"minimum_west_version_needed_to_read_this_manifest". But this is the manifest perspective, which is confusing when reading west code which is the opposite point of view. A given version of west code is never going to change when reading it or running it! So, flip the perspective and look at things from the west point of view when in the west code: rename the also vague _SCHEMA_VER to _MAX_SUPPORTED_SCHEMA_VER.