Minor improvement to documentation over block_cycles

Suggested by haneefmubarak
2019-07-28 20:42:13 -05:00
parent 53a6e04712
commit 38a2a8d2a3
2 changed files with 11 additions and 6 deletions
@@ -190,9 +190,10 @@ struct lfs_config {
    // Number of erasable blocks on the device.
    lfs_size_t block_count;

-    // Number of erase cycles before we should move logs to another block.
-    // Suggested values are in the range 100-1000, with large values having
-    // better performance at the cost of less consistent wear distribution.
+    // Number of erase cycles before littlefs evicts metadata logs and moves 
+    // the metadata to another block. Suggested values are in the
+    // range 100-1000, with large values having better performance at the cost
+    // of less consistent wear distribution.
    //
    // Set to -1 to disable block-level wear-leveling.
    int32_t block_cycles;