You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: migration_guide: add note on new ZMS backend for Settings
Add notes on how to maintain backward compatibility with legacy backend
Details some Kconfig options added with the new backend.
Signed-off-by: Riadh Ghaddab <[email protected]>
Copy file name to clipboardExpand all lines: doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -212,6 +212,28 @@ Libraries
212
212
213
213
This section describes the changes related to libraries.
214
214
215
+
ZMS Settings backend
216
+
--------------------
217
+
218
+
.. toggle::
219
+
220
+
The new ZMS backend for Settings is not backward compatible with the old version.
221
+
222
+
To keep using the legacy backend, enable the :kconfig:option:`CONFIG_SETTINGS_ZMS_LEGACY` Kconfig option.
223
+
224
+
To migrate from the legacy backend to the new backend remove :kconfig:option:`CONFIG_SETTINGS_ZMS_NAME_CACHE`
225
+
and :kconfig:option:`CONFIG_SETTINGS_ZMS_NAME_CACHE_SIZE` from your conf files.
226
+
227
+
For the new backend you can now enable some performance optimizations using the following Kconfig options:
228
+
229
+
* :kconfig:option:`CONFIG_SETTINGS_ZMS_LL_CACHE`: Used for caching the linked list nodes related to Settings Key/Value entries.
230
+
* :kconfig:option:`CONFIG_SETTINGS_ZMS_LL_CACHE_SIZE`: The size of the linked list cache (each entry occupies 8B of RAM).
231
+
* :kconfig:option:`CONFIG_SETTINGS_ZMS_NO_LL_DELETE`: Disables deleting the linked list nodes when deleting a Settings Key.
232
+
Use this option only when the application is always using the same Settings Keys.
233
+
When the application uses random Keys, enabling this option could lead to incrementing the linked list nodes without corresponding Keys and cause excessive delays to loading of the Keys.
234
+
Use this option only to accelerate the delete operation for a fixed set of Settings elements.
235
+
* :kconfig:option:`CONFIG_SETTINGS_ZMS_LOAD_SUBTREE_PATH`: Loads first the subtree path passed in the argument, then continue to load all the Keys in the same subtree if the handler returns a zero value.
0 commit comments