From a25681b2a6c85bff3fa308c29ba3634b7894c0bd Mon Sep 17 00:00:00 2001 From: Xenoamor Date: Sun, 11 Sep 2022 10:11:23 +0100 Subject: [PATCH] Improve lfs_file_close usage description 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 --- lfs.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lfs.h b/lfs.h index 3fc1e982..2bce17f5 100644 --- a/lfs.h +++ b/lfs.h @@ -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,