From 9a64eec848f8c8c6798324c25a175b7c8bf615b9 Mon Sep 17 00:00:00 2001 From: Dominik Ermel Date: Thu, 11 Mar 2021 14:35:22 +0000 Subject: [PATCH] doc: fs: Add information on samples that utilize VFS There are several interesting use caseis of VFS scattered around in samples, for example usage of FAT in RAM in USB mass storage that are worth mentioning in VFS reference documentation. Signed-off-by: Dominik Ermel --- doc/reference/file_system/index.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/reference/file_system/index.rst b/doc/reference/file_system/index.rst index 2ef9854a450..9174deb868b 100644 --- a/doc/reference/file_system/index.rst +++ b/doc/reference/file_system/index.rst @@ -44,10 +44,18 @@ where -Sample -****** +Samples +******* -A sample of how the file system can be used is supplied in ``samples/subsys/fs``. +Samples for the VFS are mainly supplied in ``samples/subsys/fs``, although various examples of the +VFS usage are provided as important functionalities in samples for different subsystems. +Here is the list of samples worth looking at: + +- ``samples/subsys/fs/fat_fs`` is an example of FAT file system usage with SDHC media; +- ``samples/subsys/shell/fs`` is an example of Shell fs subsystem, using internal flash partition + formatted to LittleFS; +- ``samples/subsys/usb/mass/`` example of USB Mass Storage device that uses FAT FS driver with RAM + or SPI connected FLASH, or LittleFS in flash, depending on the sample configuration. API Reference *************