Skip to content

Commit 77759bb

Browse files
committed
doc: nrf-bm: subsys: bm_zms: library to subsystem
Rewords in order to update from library to subsystem. Signed-off-by: Mirko Covizzi <mirko.covizzi@nordicsemi.no>
1 parent a02377b commit 77759bb

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

doc/nrf-bm/subsys/bm_zms.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Bare Metal Zephyr Memory Storage (BM_ZMS)
44
#########################################
55

6-
Bare Metal Zephyr Memory Storage is a key-value storage system that is designed to work with all types of non-volatile storage technologies.
6+
Bare Metal Zephyr Memory Storage is a key-value storage subsystem that is designed to work with all types of non-volatile storage technologies.
77

88
The Bare Metal version is designed to work with asynchronous and synchronous storage APIs.
99

@@ -20,9 +20,9 @@ The key-value pair is divided into two parts:
2020
Additionally, each sector includes header ATEs at the last positions.
2121
These ATEs are essential for describing the sector's status (whether it is 'closed' or 'open') and for indicating the current version of BM_ZMS.
2222

23-
When the current sector is full, the library verifies first that the following sector is empty.
23+
When the current sector is full, the subsystem verifies first that the following sector is empty.
2424
It then garbage collects the sector N+2, where N is the current sector number, by moving the valid ATEs to the N+1 empty sector.
25-
The library then erases the garbage-collected sector and closes the current sector by writing a ``garbage_collect_done`` ATE and the ``close`` ATE (one of the header entries).
25+
The subsystem then erases the garbage-collected sector and closes the current sector by writing a ``garbage_collect_done`` ATE and the ``close`` ATE (one of the header entries).
2626

2727
Afterwards, it moves forward to the next sector and starts writing entries again.
2828

@@ -94,7 +94,7 @@ This ATE can appear at any position of the sector.
9494
BM_ZMS workflow
9595
***************
9696

97-
The following sections describe in detail the operations performed by this library.
97+
The following sections describe in detail the operations performed by this subsystem.
9898

9999
Registering the user callback handler
100100
=====================================
@@ -135,7 +135,7 @@ To do this, it looks for a closed sector followed by an open one.
135135
Then, within the open sector, it finds (recovers) the last written ATE.
136136
After that, it checks that the sector after this one is empty, or it will erase it.
137137

138-
If this initialization is successful, the library sets the flag ``bm_zms_fs.init_flags.initialized`` to true.
138+
If this initialization is successful, the subsystem 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

141141
BM_ZMS ID/data write
@@ -299,7 +299,7 @@ Where:
299299
Features
300300
********
301301

302-
The current version of this library offers the following features:
302+
The current version of this subsystem offers the following features:
303303

304304
**Version 1**
305305

samples/subsys/fs/bm_zms/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Bare Metal Zephyr Memory Storage (BM_ZMS)
77
:local:
88
:depth: 2
99

10-
The BM_ZMS sample demonstrates how to use the Bare Metal ZMS (Zephyr Memory Storage) library to manage key-value pairs, counters, and long arrays in a storage system.
10+
The BM_ZMS sample demonstrates how to use the Bare Metal ZMS (Zephyr Memory Storage) subsystem to manage key-value pairs, counters, and long arrays in a storage system.
1111
It shows how to add, read, and delete items in the storage.
1212

1313
Refer to the `Kconfig fragments`_ section for more information on configuration.

0 commit comments

Comments
 (0)