adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 8

doc: Update the File Systems samples link syntax

Browse source 
The commit 16183f665e ("samples: subsys: fs: create common fs sample")
renames the sample name for FAT fs from 'fat_fs' to 'fs_sample'.

To avoid this kind of errors, ":zephyr:code-sample:`xxx`" is introduced.

Signed-off-by: Haiyue Wang <haiyuewa@163.com>
This commit is contained in:
Haiyue Wang 2025-01-15 21:27:17 +08:00 committed by Benjamin Cabé
parent 6043af638d
commit 4cc76e8a9a
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/services/file_system/index.rst
View file

@ -51,11 +51,11 @@ Samples for the VFS are mainly supplied in ``samples/subsys/fs``, although vario
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.
- :zephyr:code-sample:`fs` is an example of FAT file system usage with SDHC media;
- :zephyr:code-sample:`shell-fs` is an example of Shell fs subsystem, using internal flash partition
formatted to LittleFS;
- :zephyr:code-sample:`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
*************