Skip to content

Commit bac73f5

Browse files
committed
doc: nrf-bm: libraries: bm_zms: explain clearing
Adds section that explains how to handle the storage system clear. Signed-off-by: Mirko Covizzi <mirko.covizzi@nordicsemi.no>
1 parent 05863eb commit bac73f5

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/nrf-bm/libraries/bm_zms.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,14 @@ After that, it checks that the sector after this one is empty, or it will erase
138138
If this initialization is successful, the library sets the flag ``bm_zms_fs.init_flags.initialized`` to true.
139139
For asynchronous storage backends, you must wait for the initialization to finish before triggering a write or read operation.
140140

141+
Clearing the storage system
142+
===========================
143+
144+
Call the :c:func:`bm_zms_clear` function to clear the storage.
145+
146+
When this uninitialization is successful, the library sets the flag :c:member:`bm_zms_fs.init_flags.initialized` to false.
147+
For asynchronous storage backends, you must wait for the uninitialization to finish before reinitializing the storage system.
148+
141149
BM_ZMS ID/data write
142150
====================
143151

0 commit comments

Comments
 (0)