Skip to content

Commit 4cc76e8

Browse files
haiyuewakartben
authored andcommitted
doc: Update the File Systems samples link syntax
The commit 16183f6 ("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 <[email protected]>
1 parent 6043af6 commit 4cc76e8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/services/file_system/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ Samples for the VFS are mainly supplied in ``samples/subsys/fs``, although vario
5151
VFS usage are provided as important functionalities in samples for different subsystems.
5252
Here is the list of samples worth looking at:
5353

54-
- ``samples/subsys/fs/fat_fs`` is an example of FAT file system usage with SDHC media;
55-
- ``samples/subsys/shell/fs`` is an example of Shell fs subsystem, using internal flash partition
56-
formatted to LittleFS;
57-
- ``samples/subsys/usb/mass/`` example of USB Mass Storage device that uses FAT FS driver with RAM
58-
or SPI connected FLASH, or LittleFS in flash, depending on the sample configuration.
54+
- :zephyr:code-sample:`fs` is an example of FAT file system usage with SDHC media;
55+
- :zephyr:code-sample:`shell-fs` is an example of Shell fs subsystem, using internal flash partition
56+
formatted to LittleFS;
57+
- :zephyr:code-sample:`usb-mass` example of USB Mass Storage device that uses FAT FS driver with RAM
58+
or SPI connected FLASH, or LittleFS in flash, depending on the sample configuration.
5959

6060
API Reference
6161
*************

0 commit comments

Comments
 (0)