Skip to content

Commit

Permalink
Improve lfs_file_close usage description
Browse files Browse the repository at this point in the history
Improve the lfs_file_close usage description to make it clearer that the configuration structure must remain valid for its lifetime

In reference to #722
  • Loading branch information
Xenoamor authored and geky committed Sep 12, 2022
1 parent 40dba4a commit a25681b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions lfs.h
Original file line number Diff line number Diff line change
Expand Up @@ -534,8 +534,8 @@ int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
// are values from the enum lfs_open_flags that are bitwise-ored together.
//
// The config struct provides additional config options per file as described
// above. The config struct must be allocated while the file is open, and the
// config struct must be zeroed for defaults and backwards compatibility.
// above. The config struct must remain allocated while the file is open, and
// the config struct must be zeroed for defaults and backwards compatibility.
//
// Returns a negative error code on failure.
int lfs_file_opencfg(lfs_t *lfs, lfs_file_t *file,
Expand Down

0 comments on commit a25681b

Please # to comment.