michaelh/zephyr
1
0
Fork 0
Code Releases Activity

settings: doc: Update the backend documentation

Browse source 
This commit updates the settings backend documentation
to clearly state that it cannot provide old entities
before the final one.

Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no>
This commit is contained in:
Radoslaw Koppel 2019-10-11 17:42:11 +02:00 • committed by Carles Cufí
commit bb9c453777
2 changed files with 12 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/settings/settings.h
View file

@ -390,6 +390,12 @@ struct settings_store_itf {
* Parameters:
* - cs - Corresponding backend handler node,
* - arg - Structure that holds additional data for data loading.
*
* @note
* Backend is expected not to provide duplicates of the entities.
* It means that if the backend does not contain any functionality to
* really delete old keys, it has to filter out old entities and call
* load callback only on the final entity.
*/
int (*csi_save_start)(struct settings_store *cs);