docs: clarify URL field behavior in JSON manifest format #165
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.
Scope of Change
This PR adds important documentation clarification to the README.md file regarding JSON manifest format behavior. Specifically, it adds a warning section that explains how the
url
field interacts with other URL-related fields.What the change does:
url
field is present, all other URL-related fields are ignoredParts of code modified:
Background
Users were experiencing confusion when trying to use both
url
and filesystem fields (littlefs
,spiffs
,fatfs
) in the same manifest, expecting both to work. The current library behavior (as implemented incheckJSONManifest()
) ignores all other URL-related fields whenurl
is present, but this wasn't documented.Known Limitations
Testing
This change helps prevent user confusion and makes the manifest format requirements explicit, improving the developer experience when working with filesystem updates.