Skip to content

FS: Improve documentaiton on mounting file systems. #89022

@de-nordic

Description

@de-nordic

Is your enhancement proposal related to a problem? Please describe.

The documentation does not clearly describe how to properly fill in fs_mount_t structure passed to fs_mount, specifically that there is a difference on usage of fields like .storage_dev between systems and how it is used and modified by fs_mount:
https://docs.zephyrproject.org/latest/services/file_system/index.html

Describe the solution you'd like
More clear documentation, maybe dedicated paragraphs to LittleFS other FS.

Describe alternatives you've considered
There is no alternative to fixing that.

Additional context
The mentioned storage_dev is actually not even mentioned in https://docs.zephyrproject.org/latest/services/file_system/index.html example, even though the LittleFS uses it to pass partition id, it later uses to obtain flash_area object with, and actually stores the object pointer to this member; and the ext2 uses Disk name here.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions