storage/stream_flash: Document write flush as mandatory #68660
Merged
Conversation
This file contains 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
kartben
requested changes
Feb 28, 2024
Comment on lines
109
to
113
| * A write with the @p flush set to true has to be issued as the last | ||
| * write request for a given context, as it concludes write of a stream; | ||
| * there must not be issued any more write requests for given context, | ||
| * unless it is re-initialized, and such write attempts may result in the | ||
| * function returning error. |
There was a problem hiding this comment.
this seems redundant with L102-103. I would completely remove this section and instead only update L102-103 (also maybe make it a @warning to make it stand out more?) to add the extra explanation regarding the expected behavior after a flush write. Maybe
There was a problem hiding this comment.
@kartben Does this look better now?
de-nordic
force-pushed
the
stream_flash_write_doc
branch
2 times, most recently
from
ff84c59 to
06cc2e8
Compare
kartben
reviewed
Apr 24, 2024
There is no need to make this optional just inform user that this has to be called to complete write of buffers. The commit also adds info that there should be no more write attempts done with use of "flushed", as it may return write errors anyway. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
de-nordic
force-pushed
the
stream_flash_write_doc
branch
from
cd76d49 to
e1056c9
Compare
Sorry, should have run check before push. |
kartben
approved these changes
Apr 24, 2024
gmarull
approved these changes
Apr 25, 2024
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.
There is no need to make this optional just inform user that this has to be called to complete write of buffers. The commit also adds info that there should be no more write attempts done with use of "flushed", as it may return write errors anyway.