Skip to content

doc: fs: document preconditions with fs_open & fs_opendir #97291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

doc: fs: document preconditions with fs_open & fs_opendir #97291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions include/zephyr/fs/fs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ static inline void fs_dir_t_init(struct fs_dir_t *zdp)
* @warning If @p flags are set to 0 the function will open file, if it exists
* and is accessible, but you will have no read/write access to it.
*
* @param zfp Pointer to a file object
* @param zfp Pointer to an @b initialized file object
* @param file_name The name of a file to open
* @param flags The mode flags
*
Expand Down Expand Up @@ -506,7 +506,7 @@ int fs_mkdir(const char *path);
*
* Opens an existing directory specified by the path.
*
* @param zdp Pointer to the directory object
* @param zdp Pointer to the @b initialized directory object
* @param path Path to the directory to open
*
* @retval 0 on success;
Expand Down