doc: settings: Add storage location section

Add section documenting how the settings storage location is selected by different backends. Signed-off-by: Alexander Mihajlovic <[email protected]>
kolen · Mar 24, 2022 · 2888523 · 2888523
1 parent 245d217
commit 2888523
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/doc/reference/settings/index.rst b/doc/reference/settings/index.rst
@@ -102,6 +102,17 @@ Non-volatile storage read target is registered using
 ``settings_nvs_src()``, and write target by using
 ``settings_nvs_dst()``.
 
+Storage Location
+****************
+
+The FCB and non-volatile storage (NVS) backends both look for a fixed
+partition with label "storage" by default. A different partition can be
+selected by setting the ``zephyr,settings-partition`` property of the
+chosen node in the devicetree.
+
+The file path used by the file system backend to store settings
+is selected via the option ``CONFIG_SETTINGS_FS_FILE``.
+
 Loading data from persisted storage
 ***********************************