fs: zms: clarify need to re-mount after zms_clear

Emil Hammarström · kartben · commit 01ba1bf8ce09 · 2025-03-31T14:32:08.000+02:00
Clarify that the file system needs to be re-mounted after clearing.
It was not clear that zms_clear both cleared and unmounted the fs.

Signed-off-by: Emil Hammarström &lt;emil.hammarstrom1@assaabloy.com&gt;
diff --git a/include/zephyr/fs/zms.h b/include/zephyr/fs/zms.h
@@ -92,7 +92,8 @@ struct zms_fs {
 int zms_mount(struct zms_fs *fs);
 
 /**
- * @brief Clear the ZMS file system from device.
+ * @brief Clear the ZMS file system from device. The ZMS file system must be re-mounted after this
+ * operation.
  *
  * @param fs Pointer to the file system.
  *

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,8 @@ struct zms_fs {`
`92`	`92`	`int zms_mount(struct zms_fs *fs);`
`93`	`93`
`94`	`94`	`/**`
`95`		`- * @brief Clear the ZMS file system from device.`
	`95`	`+ * @brief Clear the ZMS file system from device. The ZMS file system must be re-mounted after this`
	`96`	`+ * operation.`
`96`	`97`	`*`
`97`	`98`	`* @param fs Pointer to the file system.`
`98`	`99`	`*`