Skip to content

Commit a02377b

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

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

doc/nrf-bm/subsys/bm_storage.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
.. _lib_storage:
22

3-
Storage Library
4-
###############
3+
Bare Metal Storage
4+
##################
55

66
.. contents::
77
:local:
88
:depth: 2
99

10-
The Storage library provides abstractions for reading, writing, and erasing non-volatile memory (NVM).
10+
The Bare Metal Storage subsystem provides abstractions for reading, writing, and erasing non-volatile memory (NVM).
1111

1212
Overview
1313
********
1414

15-
The library supports multiple storage instances, each bound to a specific memory region, and reports operation results through user-defined event handlers.
15+
The subsystem supports multiple storage instances, each bound to a specific memory region, and reports operation results through user-defined event handlers.
1616
Depending on the backend and runtime state, operations may be synchronous or asynchronous.
1717

1818
Configuration
1919
*************
2020

21-
The library is enabled and configured entirely using the Kconfig system.
22-
Set the :kconfig:option:`CONFIG_BM_STORAGE` Kconfig option to enable the library.
21+
The subsystem is enabled and configured entirely using the Kconfig system.
22+
Set the :kconfig:option:`CONFIG_BM_STORAGE` Kconfig option to enable the subsystem.
2323

2424
Select a storage backend by enabling one of the following Kconfig options:
2525

@@ -46,7 +46,7 @@ You can uninitialize a storage instance with the :c:func:`bm_storage_uninit` fun
4646
Usage
4747
*****
4848

49-
The following is a list of operations you can perform with this library.
49+
The following is a list of operations you can perform with this subsystem.
5050

5151
Read
5252
====
@@ -103,7 +103,7 @@ Each event includes the result code, information about the address range of the
103103
Sample
104104
******
105105

106-
The usage of this library is demonstrated in the :ref:`bm_storage_sample` sample.
106+
The usage of this subsystem is demonstrated in the :ref:`bm_storage_sample` sample.
107107

108108
Dependencies
109109
************
@@ -128,4 +128,4 @@ API documentation
128128
| Header file: :file:`include/bm_storage.h`
129129
| Source files: :file:`lib/bm_storage/`
130130
131-
:ref:`Storage library API reference <api_storage>`
131+
:ref:`Bare Metal Storage subsystem API reference <api_storage>`

include/bm/storage/bm_storage.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
/** @file
88
*
9-
* @defgroup bm_storage NCS Bare Metal Storage library
9+
* @defgroup bm_storage NCS Bare Metal Storage subsystem
1010
* @{
1111
*
12-
* @brief Library that provides abstractions for operations such as read, write, and erase
12+
* @brief Subsystem that provides abstractions for operations such as read, write, and erase
1313
* on non-volatile memory.
1414
*/
1515

0 commit comments

Comments
 (0)