[PATCH 28/42] state: backend_storage: rewrite function doc

[Sascha Hauer]

The function documentation for state_storage_file_buckets_init() is not
very accurate. Rewrite it.

Signed-off-by: Sascha Hauer <s.hauer at pengutronix.de>
---
 common/state/backend_storage.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/common/state/backend_storage.c b/common/state/backend_storage.c
index 1310531dd1..bc531ef991 100644
--- a/common/state/backend_storage.c
+++ b/common/state/backend_storage.c
@@ -289,8 +289,8 @@ static int state_storage_mtd_buckets_init(struct state_backend_storage *storage,
  * @param storage Storage object
  * @return 0 on success, -errno otherwise
  *
- * For blockdevices and other regular files we create direct buckets beginning
- * at offset 0. Direct buckets are simple and write data always to offset 0.
+ * direct buckets are simpler than circular buckets and can be used on blockdevices
+ * and mtd devices that don't need erase (MRAM). Also used for EEPROMs.
  */
 static int state_storage_file_buckets_init(struct state_backend_storage *storage)
 {
-- 
2.11.0