samples: subsys: fs: bm_zms: add wait after clear #490
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
github-actions
bot
added
the
changelog-entry-required
MirkoCovizzi
removed
the
changelog-entry-required
|
You can find the documentation preview for this PR here. |
github-actions
bot
added
changelog-entry-required
MirkoCovizzi
removed
the
changelog-entry-required
MirkoCovizzi
force-pushed
the
fix-zms-sample
branch
from
e55e8c4 to
a73dfb8
Compare
github-actions
bot
added
the
changelog-entry-required
MirkoCovizzi
removed
the
changelog-entry-required
MirkoCovizzi
force-pushed
the
fix-zms-sample
branch
from
a73dfb8 to
b9a5b6f
Compare
github-actions
bot
added
the
changelog-entry-required
MirkoCovizzi
force-pushed
the
fix-zms-sample
branch
from
b9a5b6f to
f446ab9
Compare
MirkoCovizzi
changed the title
b-gent
approved these changes
Nov 19, 2025
doc/nrf-bm/libraries/bm_zms.rst
Outdated
| Clearing the storage system | ||
| =========================== | ||
|
|
||
| The :c:func:`bm_zms_clear` function must be called to clear the storage. |
Contributor
There was a problem hiding this comment.
Suggested change
| The :c:func:`bm_zms_clear` function must be called to clear the storage. | |
| Call the :c:func:`bm_zms_clear` function to clear the storage. |
doc/nrf-bm/libraries/bm_zms.rst
Outdated
| The :c:func:`bm_zms_clear` function must be called to clear the storage. | ||
|
|
||
| When this uninitialization is successful, the library sets the flag :c:member:`bm_zms_fs.init_flags.initialized` to false. | ||
| For asynchronous storage backends, you must wait for the uninitialization to finish before re-initializing the storage system. |
Contributor
There was a problem hiding this comment.
Suggested change
| For asynchronous storage backends, you must wait for the uninitialization to finish before re-initializing the storage system. | |
| For asynchronous storage backends, you must wait for the uninitialization to finish before reinitializing the storage system. |
MirkoCovizzi
force-pushed
the
fix-zms-sample
branch
from
f446ab9 to
bac73f5
Compare
doc/nrf-bm/libraries/bm_zms.rst
Outdated
| Clearing the storage system | ||
| =========================== | ||
|
|
||
| Call the :c:func:`bm_zms_clear` function to clear the storage. |
Contributor
There was a problem hiding this comment.
Perhaps state explicitly here that it uinintializes the zms instance.
Suggested change
| Call the :c:func:`bm_zms_clear` function to clear the storage. | |
| Call the :c:func:`bm_zms_clear` function to clear the storage and uninitialize the ZMS instance. |
|
MirkoCovizzi
force-pushed
the
fix-zms-sample
branch
from
bac73f5 to
d0affad
Compare
The `bm_zms_clear` function executes write operations under the hood that can be asynchronous. The condition of termination for the operation is when the file system is set to uninitialized. Adds a check for this condition before terminating the sample. Signed-off-by: Mirko Covizzi <[email protected]>
Adds section that explains how to handle the storage system clear. Signed-off-by: Mirko Covizzi <[email protected]>
MirkoCovizzi
force-pushed
the
fix-zms-sample
branch
from
d0affad to
decc84c
Compare
MirkoCovizzi
removed
the
changelog-entry-required
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The
bm_zms_clearfunction executes write operations under the hood that can be asynchronous.The condition of termination for the operation is when the file system is set to uninitialized.
Adds a check for this condition before terminating the sample.