Github/littlefs
1
Fork 0
Code Actions Activity

Renamed public API params to match internal names

Browse Source 
- traversal -> t
- config -> cfg

This is just to make things consistent in case users want to peek behind
the curtain.
This commit is contained in:
Christopher Haster
2024-07-26 16:46:14 -05:00
parent b37bff377b
commit e66170308e
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lfs.h
+7 -8
View File
@@ -774,7 +774,7 @@ typedef struct lfs {
// //
// Returns a negative error code on failure. // Returns a negative error code on failure.
//int lfs_format(lfs_t *lfs, const struct lfs_config *config); //int lfs_format(lfs_t *lfs, const struct lfs_config *config);
int lfsr_format(lfs_t *lfs, const struct lfs_config *config); int lfsr_format(lfs_t *lfs, const struct lfs_config *cfg);
#endif #endif
// Mounts a littlefs // Mounts a littlefs
@@ -787,7 +787,7 @@ int lfsr_format(lfs_t *lfs, const struct lfs_config *config);
// Returns a negative error code on failure. // Returns a negative error code on failure.
//int lfs_mount(lfs_t *lfs, const struct lfs_config *config); //int lfs_mount(lfs_t *lfs, const struct lfs_config *config);
int lfsr_mount(lfs_t *lfs, uint32_t flags, int lfsr_mount(lfs_t *lfs, uint32_t flags,
const struct lfs_config *config); const struct lfs_config *cfg);
// Unmounts a littlefs // Unmounts a littlefs
// //
@@ -895,7 +895,7 @@ int lfsr_file_open(lfs_t *lfs, lfsr_file_t *file,
// const struct lfs_file_config *config); // const struct lfs_file_config *config);
int lfsr_file_opencfg(lfs_t *lfs, lfsr_file_t *file, int lfsr_file_opencfg(lfs_t *lfs, lfsr_file_t *file,
const char *path, uint32_t flags, const char *path, uint32_t flags,
const struct lfs_file_config *config); const struct lfs_file_config *cfg);
// Close a file // Close a file
// //
@@ -1097,14 +1097,13 @@ int lfsr_dir_rewind(lfs_t *lfs, lfsr_dir_t *dir);
// the filesystem. // the filesystem.
// //
// Returns a negative error code on failure. // Returns a negative error code on failure.
int lfsr_traversal_open(lfs_t *lfs, lfsr_traversal_t *traversal, int lfsr_traversal_open(lfs_t *lfs, lfsr_traversal_t *t, uint32_t flags);
uint32_t flags);
// Close a traversal // Close a traversal
// //
// Releases any allocated resources. // Releases any allocated resources.
// Returns a negative error code on failure. // Returns a negative error code on failure.
int lfsr_traversal_close(lfs_t *lfs, lfsr_traversal_t *traversal); int lfsr_traversal_close(lfs_t *lfs, lfsr_traversal_t *t);
// Progress the traversal and read an entry // Progress the traversal and read an entry
// //
@@ -1112,13 +1111,13 @@ int lfsr_traversal_close(lfs_t *lfs, lfsr_traversal_t *traversal);
// //
// Returns 0 on success, LFS_ERR_NOENT at the end of traversal, or a // Returns 0 on success, LFS_ERR_NOENT at the end of traversal, or a
// negative error code on failure. // negative error code on failure.
int lfsr_traversal_read(lfs_t *lfs, lfsr_traversal_t *traversal, int lfsr_traversal_read(lfs_t *lfs, lfsr_traversal_t *t,
struct lfs_tinfo *tinfo); struct lfs_tinfo *tinfo);
// Reset the traversal // Reset the traversal
// //
// Returns a negative error code on failure. // Returns a negative error code on failure.
int lfsr_traversal_rewind(lfs_t *lfs, lfsr_traversal_t *traversal); int lfsr_traversal_rewind(lfs_t *lfs, lfsr_traversal_t *t);
/// Filesystem-level filesystem operations /// Filesystem-level filesystem operations