michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: provide guidance on recommended settings back end

Browse source 
Zephyr release 2.1 changed the default settings back end from FCB to
NVS in all Bluetooth samples for performance and reliability reasons.
Update the settings documentation to provide a clue to developers
trying to decide which to use.

Signed-off-by: Peter A. Bigot <pab@pabigot.com>
This commit is contained in:
Peter A. Bigot 2020-07-26 06:05:07 -05:00 • committed by Ioannis Glaropoulos
commit 5c85e2c914
2 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/reference/settings/index.rst
View file

@ -22,6 +22,11 @@ and from a string type.
For an example of the settings subsystem refer to For an example of the settings subsystem refer to
:ref:`the sample <settings_subsys_sample>`. :ref:`the sample <settings_subsys_sample>`.
.. note::
As of Zephyr release 2.1 the recommended backend for non-filesystem
storage is :ref:`NVS <nvs_api>`.
Handlers Handlers
******** ********

6
doc/reference/storage/fcb/fcb.rst
View file

@ -7,6 +7,12 @@ Flash circular buffer provides an abstraction through which you can treat
flash like a FIFO. You append entries to the end, and read data from the flash like a FIFO. You append entries to the end, and read data from the
beginning. beginning.
.. note::
As of Zephyr release 2.1 the :ref:`NVS <nvs_api>` storage API is
recommended over FCB for use as a back-end for the :ref:`settings API
<settings_api>`.
Description Description
*********** ***********