summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2017-03-24 09:07:19 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2017-03-31 18:43:53 +0200
commitec5f8eb29331de692d3ffdb26bbf3b5f47b61e5c (patch)
tree2736c9ac29dc0bc1987b1e5423b06aa79985f76f
parent13a3c584b49e1a91d825fee3771ce655bf67f1b5 (diff)
downloadbarebox-ec5f8eb29331de692d3ffdb26bbf3b5f47b61e5c.tar.gz
barebox-ec5f8eb29331de692d3ffdb26bbf3b5f47b61e5c.tar.xz
state: backend_storage: rewrite function doc
The function documentation for state_storage_file_buckets_init() is not very accurate. Rewrite it. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
-rw-r--r--common/state/backend_storage.c4
1 files 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)
{