alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-12-10 18:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit

Browse Source
This commit is contained in:
kirill.chalov
2024-01-19 14:40:33 +08:00
parent 9ba5f4dab2
commit 22a053f1fc
195 changed files with 2385 additions and 2393 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst
View File

@@ -84,4 +84,4 @@ If the ``ESP_INTR_FLAG_IRAM`` flag is not set when registering, the interrupt ha
.. only:: SOC_SPIRAM_XIP_SUPPORTED
.. include:: xip_from_psram.inc
.. include:: xip_from_psram.inc

2
docs/en/api-reference/peripherals/spi_flash/spi_flash_override_driver.rst
View File

@@ -37,7 +37,7 @@ Steps For Creating Custom Chip Drivers and Overriding the ESP-IDF Default Driver
.. note::
- When writing your own flash chip driver, you can set your flash chip capabilities through ``spi_flash_chip_***(vendor)_get_caps`` and points the function pointer ``get_chip_caps`` for protection to the ``spi_flash_chip_***_get_caps`` function. The steps are as follows.
1. Please check whether your flash chip have the capabilities listed in ``spi_flash_caps_t`` by checking the flash datasheet.
2. Write a function named ``spi_flash_chip_***(vendor)_get_caps``. Take the example below as a reference. (if the flash support ``suspend`` and ``read unique id``).
3. Points the pointer ``get_chip_caps`` (in ``spi_flash_chip_t``) to the function mentioned above.