Clarify that wolfBoot_open_image_address expects the passed in img structure to be memset and does not perform the memset itself.#712
Merged
danielinux merged 2 commits intowolfSSL:masterfrom Mar 5, 2026
Conversation
…ructure to be memset and does not perform the memset itself.
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies the caller contract for wolfBoot_open_image_address() by documenting that the wolfBoot_image struct must be zero-initialized by the caller (Fixes ZD 21134).
Changes:
- Updated the API comment in
src/image.cto state the caller mustmemsetthewolfBoot_imagestruct before calling. - Updated
docs/lib.mdto reflect the same expectation forimg.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/image.c | Adds API comment clarifying caller-managed struct zero-initialization. |
| docs/lib.md | Updates library documentation to mention img must be memset before use. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
danielinux
approved these changes
Mar 5, 2026
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
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.
Fixes ZD 21134.