From 1bc14933b76a6fc0b8b82f6a46479ff396be2656 Mon Sep 17 00:00:00 2001 From: Christopher Haster Date: Wed, 17 Apr 2024 00:16:20 -0500 Subject: [PATCH] Tweaked on-disk config comments for consistency - Prefer "defaults to blablabla when zero" to hint that this is the default state when both explicitly set to zero and implicitly set to zero thanks to C's initializers. - Prefer "disk" when referencing something stored "on disk". Other terms can quickly get ambiguous. Except maybe "block device"... --- lfs.h | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/lfs.h b/lfs.h index 274259e..8473897 100644 --- a/lfs.h +++ b/lfs.h @@ -59,7 +59,8 @@ typedef uint32_t lfs_block_t; #endif // Maximum size of custom attributes in bytes, may be redefined, but there is -// no real benefit to using a smaller LFS_ATTR_MAX. Limited to <= 1022. +// no real benefit to using a smaller LFS_ATTR_MAX. Limited to <= 1022. Stored +// in superblock and must be respected by other littlefs drivers. #ifndef LFS_ATTR_MAX #define LFS_ATTR_MAX 1022 #endif @@ -203,8 +204,8 @@ struct lfs_config { // program sizes. lfs_size_t block_size; - // Number of erasable blocks on the device. - // If 0, will attempt to infer block_count from existing filesystem. + // Number of erasable blocks on the device. Defaults to block_count stored + // on disk when zero. lfs_size_t block_count; // Number of erase cycles before littlefs evicts metadata logs and moves @@ -253,18 +254,18 @@ struct lfs_config { // Optional upper limit on length of file names in bytes. No downside for // larger names except the size of the info struct which is controlled by - // the LFS_NAME_MAX define. Defaults to LFS_NAME_MAX when zero. Stored in - // superblock and must be respected by other littlefs drivers. + // the LFS_NAME_MAX define. Defaults to LFS_NAME_MAX or name_max stored on + // disk when zero. lfs_size_t name_max; // Optional upper limit on files in bytes. No downside for larger files - // but must be <= LFS_FILE_MAX. Defaults to LFS_FILE_MAX when zero. Stored - // in superblock and must be respected by other littlefs drivers. + // but must be <= LFS_FILE_MAX. Defaults to LFS_FILE_MAX or file_max stored + // on disk when zero. lfs_size_t file_max; // Optional upper limit on custom attributes in bytes. No downside for // larger attributes size but must be <= LFS_ATTR_MAX. Defaults to - // LFS_ATTR_MAX when zero. + // LFS_ATTR_MAX or attr_max stored on disk when zero. lfs_size_t attr_max; // Optional upper limit on total space given to metadata pairs in bytes. On