OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: storage: nvs: Fixed data CRC notes formatting 

Used the same notes format than in other parts of the documentation.

Signed-off-by: Adrien Ricciardi <aricciardi@baylibre.com>
This commit is contained in:
Adrien Ricciardi 2024-06-20 18:37:48 +02:00 committed by Anas Nashif
parent 15d66ccc23
commit 914d7911da
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/services/storage/nvs/nvs.rst
View File

@ -24,11 +24,13 @@ only calculated over the metadata and only ensures that a write has been
completed. The actual data of the element can be protected by a different (and optional)
CRC-32. Use the :kconfig:option:`CONFIG_NVS_DATA_CRC` configuration item to enable
the data part CRC.
**Note:** the data CRC is checked only when the whole data of the element is read.
The data CRC is not checked for a partial read, as it is stored at the end of the
element data area.
**Note 2:** enabling the data CRC feature on a previously existing NVS content without
data CRC will make all existing data invalid.
.. note:: The data CRC is checked only when the whole data of the element is read.
The data CRC is not checked for a partial read, as it is stored at the end of the
element data area.
.. note:: Enabling the data CRC feature on a previously existing NVS content without
data CRC will make all existing data invalid.
A write of data to nvs always starts with writing the data, followed by a write
of the metadata. Data that is written in flash without metadata is ignored