Github/littlefs
1
Fork 0
Code Actions Activity

Tweaked on-disk config comments for consistency

Browse Source 
- 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"...
This commit is contained in:
Christopher Haster
2024-04-17 00:16:20 -05:00
parent 01b6a47ea8
commit 1bc14933b7
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lfs.h
+9 -8
View File
@@ -59,7 +59,8 @@ typedef uint32_t lfs_block_t;
#endif #endif
// Maximum size of custom attributes in bytes, may be redefined, but there is // 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 #ifndef LFS_ATTR_MAX
#define LFS_ATTR_MAX 1022 #define LFS_ATTR_MAX 1022
#endif #endif
@@ -203,8 +204,8 @@ struct lfs_config {
// program sizes. // program sizes.
lfs_size_t block_size; lfs_size_t block_size;
// Number of erasable blocks on the device. // Number of erasable blocks on the device. Defaults to block_count stored
// If 0, will attempt to infer block_count from existing filesystem. // on disk when zero.
lfs_size_t block_count; lfs_size_t block_count;
// Number of erase cycles before littlefs evicts metadata logs and moves // 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 // 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 // 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 // the LFS_NAME_MAX define. Defaults to LFS_NAME_MAX or name_max stored on
// superblock and must be respected by other littlefs drivers. // disk when zero.
lfs_size_t name_max; lfs_size_t name_max;
// Optional upper limit on files in bytes. No downside for larger files // 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 // but must be <= LFS_FILE_MAX. Defaults to LFS_FILE_MAX or file_max stored
// in superblock and must be respected by other littlefs drivers. // on disk when zero.
lfs_size_t file_max; lfs_size_t file_max;
// Optional upper limit on custom attributes in bytes. No downside for // Optional upper limit on custom attributes in bytes. No downside for
// larger attributes size but must be <= LFS_ATTR_MAX. Defaults to // 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; lfs_size_t attr_max;
// Optional upper limit on total space given to metadata pairs in bytes. On // Optional upper limit on total space given to metadata pairs in bytes. On