feat(storage/vfs): update example references in documentation

This commit is contained in:
Tomáš Rohlínek
2024-09-03 13:30:45 +02:00
committed by Tomas Rohlinek
parent d43669b2d7
commit 46982e69da
2 changed files with 49 additions and 19 deletions

View File

@@ -123,7 +123,7 @@ If you decide for any reason to use ``fatfs_create_rawflash_image`` (without wea
The arguments of the function are as follows:
#. partition - the name of the partition as defined in the partition table (e.g., :example_file:`storage/fatfsgen/partitions_example.csv`).
#. partition - the name of the partition as defined in the partition table (e.g., :example_file:`storage/fatfs/fatfsgen/partitions_example.csv`).
#. base_dir - the directory that will be encoded to FatFs partition and optionally flashed into the device. Beware that you have to specify the suitable size of the partition in the partition table.
@@ -139,7 +139,7 @@ For example::
If FLASH_IN_PROJECT is not specified, the image will still be generated, but you will have to flash it manually using ``esptool.py`` or a custom build system target.
For an example, see :example:`storage/fatfsgen`.
For an example, see :example:`storage/fatfs/fatfsgen`.
.. _fatfs-partition-analyzer:

View File

@@ -37,22 +37,15 @@ For information about storage security, please refer to :doc:`Storage Security <
wear-levelling
storage-security.rst
.. list-table:: Code Examples for Storage API
Examples
--------
.. list-table:: NVS API examples
:widths: 25 75
:header-rows: 0
* - **Code Example**
- **Description**
* - :doc:`fatfs`
-
* - :example:`wear_leveling <storage/wear_levelling>`
- Demonstrates using FATFS over wear leveling on internal flash.
* - :example:`ext_flash_fatfs <storage/ext_flash_fatfs>`
- Demonstrates using FATFS over wear leveling on external flash.
* - :example:`fatfsgen <storage/fatfsgen>`
- Demonstrates the capabilities of Python-based tooling for FATFS images available on host computers.
* - :doc:`nvs_flash`
-
* - :example:`nvs_rw_blob <storage/nvs_rw_blob>`
- Shows the use of the C-style API to read and write blob data types in NVS flash.
* - :example:`nvs_rw_value <storage/nvs_rw_value>`
@@ -61,20 +54,57 @@ For information about storage security, please refer to :doc:`Storage Security <
- Shows the use of the C++-style API to read and write integer data types in NVS flash.
* - :example:`nvsgen <storage/nvsgen>`
- Demonstrates how to use the Python-based NVS image generation tool to create an NVS partition image from the contents of a CSV file.
* - :doc:`spiffs`
-
.. list-table:: Common Filesystem API
:widths: 25 75
:header-rows: 0
* - **Code Example**
- **Description**
* - :example:`fatfs/getting_started <storage/fatfs/getting_started>`
- Demonstrates basic common file API(stdio.h) usage over internal flash using FATFS.
* - :example:`fatfs/fs_operations <storage/fatfs/fs_operations>`
- Demonstrates POSIX API for filesystem manipulation, such as moving, removing and renaming files.
.. list-table:: FATFS API examples
:widths: 25 75
:header-rows: 0
* - :example:`fatfsgen <storage/fatfs/fatfsgen>`
- Demonstrates the capabilities of Python-based tooling for FATFS images available on host computers.
* - :example:`ext_flash_fatfs <storage/fatfs/ext_flash>`
- Demonstrates using FATFS over wear leveling on external flash.
* - :example:`wear_leveling <storage/wear_levelling>`
- Demonstrates using FATFS over wear leveling on internal flash.
.. list-table:: SPIFFS API examples
:widths: 25 75
:header-rows: 0
* - **Code Example**
- **Description**
* - :example:`spiffs <storage/spiffs>`
- Shows the use of the SPIFFS API to initialize the filesystem and work with files using POSIX functions.
* - :example:`spiffsgen <storage/spiffsgen>`
- Demonstrates the capabilities of Python-based tooling for SPIFFS images available on host computers.
* - :doc:`partition`
-
.. list-table:: Partition API examples
:widths: 25 75
:header-rows: 0
* - **Code Example**
- **Description**
* - :example:`partition_api <storage/partition_api>`
- Provides an overview of API functions to look up particular partitions, perform basic I/O operations, and use partitions via CPU memory mapping.
* - :example:`parttool <storage/parttool>`
- Demonstrates the capabilities of Python-based tooling for partition images available on host computers.
* - :doc:`vfs`
-
.. list-table:: VFS related examples
:widths: 25 75
:header-rows: 0
* - **Code Example**
- **Description**
* - :example:`littlefs <storage/littlefs>`
- Shows the use of the LittleFS component to initialize the filesystem and work with a file using POSIX functions.
* - :example:`semihost_vfs <storage/semihost_vfs>`