Commit Graph

62 Commits

Author SHA1 Message Date
hrushikesh.bhosale 745e08b499 docs(nvs_flash): Updated the docs of nvs_flash
Updated the documentation by changing subtype from key to
nvs_keys in nvs_flash.rst
2024-08-21 14:44:47 +05:30
Xiao Xufeng 01560b9ca5 doc(flash): fix auto suspend enabled by default issue 2024-06-24 17:35:30 +08:00
Shang Zhou 2a1e6f73ee docs: Provide CN translation for wear-levelling.rst 2023-08-14 12:59:10 +02:00
Adam Múdry 556816423c docs(fatfs): Move mentioned APIs to a separate API reference section 2023-08-14 12:59:08 +02:00
Marius Vikhammer 5400061f6a Merge branch 'docs/elm_chan_broken_link_v5.0' into 'release/v5.0'
docs: fix broken link in fatfs doc (v5.0)

See merge request espressif/esp-idf!22297
2023-02-20 12:21:28 +08:00
Marius Vikhammer 55c2ac7b96 docs: fix rst external links with wrong format 2023-02-13 12:05:21 +08:00
Marius Vikhammer 33afa9a14a docs: fix broken link in fatfs doc 2023-02-09 16:10:57 +08:00
Jiang Jiang Jian 72b2de9dab Merge branch 'docs/c2_storage_update_v5.0' into 'release/v5.0'
docs: update storage and sleep docs for C2 (v5.0)

See merge request espressif/esp-idf!19738
2022-09-14 13:56:08 +08:00
Shang Zhou ba224e0fd9 docs: Update CN version for MR19453 2022-09-13 16:54:47 +08:00
Marius Vikhammer 8acb8bbd76 docs: update storage and sleep docs for C2 2022-09-13 16:54:47 +08:00
Mo Fei Fei ebb04bbdfe Docs: Update CN trans for nvs_flash.rst 2022-09-06 10:08:56 +02:00
Martin Gaňo a542e9424c fatfsparse.py/docs: Added missing cmd parameter to the docs 2022-07-29 15:29:23 +02:00
intern 4866e91398 docs: update nvs encryption cn trans 2022-07-18 14:40:56 +08:00
Cao Sen Miao d9b4b82edc spi_flash: Modify documentations 2022-07-01 10:59:34 +08:00
Shang Zhou 6b9d92c1d6 docs: provide CN translation for fatfsparse.py 2022-06-09 15:51:03 +02:00
Dai Zi Yan e94435df22 Merge branch 'docs/update_idf_monitor' into 'master'
docs: update CN translation for idf-monitor.rst

Closes DOC-3082

See merge request espressif/esp-idf!18248
2022-06-06 15:45:24 +08:00
daiziyan 59453d0e78 docs: update CN translation for idf-monitor.rst 2022-05-30 20:55:37 +08:00
Jakob Hasse ad184e979a refactor (nvs)!: New interface for iterator functions
Closes https://github.com/espressif/esp-idf/issues/7826

* nvs_entry_find(), nvs_entry_next() and nvs_entry_info()
  return error codes now
* nvs_entry_find() and nvs_entry_next() access/modify iterator via
  parameters, instead of returning an new iterator.

Added appropriate documentation in Chinese and English
2022-05-30 09:28:42 +08:00
unknown 5a1c257f96 docs: sync up line number for api reference 2022-05-23 20:30:29 +08:00
Shang Zhou 4ad048f05f Merge branch 'docs/update_cn_translation_of_16452_and_16658' into 'master'
docs: updated CN translation for !16452 and !16658

Closes DOC-2828 and DOC-2827

See merge request espressif/esp-idf!18007
2022-05-20 03:57:52 +08:00
Shang Zhou ed1bf1d056 docs: updated CN translation for !16452 and !16658 2022-05-20 03:57:51 +08:00
mofeifei 4d0724984c docs: update cn trans for fatfs.rst 2022-05-17 11:36:03 +08:00
Matus Fabo 24268d47a2 change: renamed FATFS convenience mounting functions
change: renamed every instance of these functions
add: deprecation notice with old functions
change: CC0 licence to CC0-1.0 in fatfsgen_example_main.c
2022-04-11 08:44:40 +00:00
Adam Múdry 36db6a6681 spiffs: Add esp_spiffs_check() function
esp_spiffs_check() exposes SPIFFS_check() functionality to the user
2022-04-08 19:40:56 +00:00
Marius Vikhammer a6543f0d21 docs: fix broken references to misc API functions and types. 2022-03-27 16:46:57 +08:00
Martin Gaňo fea2b5b64e fatfsgen.py: enabled long names support
Closes https://github.com/espressif/esp-idf/issues/8171
2022-03-11 11:20:31 +01:00
Cao Sen Miao a0bd06af54 spi_flash: Add documents for flash optional features 2022-03-09 18:49:34 +08:00
daiziyan 6b8420e877 docs: updated CN translation for using-debugger, windows-setup, resources and index 2022-02-25 10:44:22 +00:00
Shang Zhou 33a00cf197 docs: Updated CN translation for index files in api-guides and api-reference 2022-02-23 14:48:26 +08:00
Armando 49658faaf0 doc: add flash suspend feature to iram usage doc 2022-01-24 12:59:29 +08:00
David Cermak 10dc8543c5 vfs/lwip: Fix docs on select() referencing wrong config
CONFIG_LWIP_USE_ONLY_LWIP_SELECT was deprecated long time ago and removed (~ in v4.x).
Used CONFIG_VFS_SUPPORT_SELECT instead (and reverted the logic as this
is ON by default and needs to be explicitly turned off for socket only
select)
2022-01-14 16:41:38 +01:00
daiziyan 20374161a6 docs: Updated CN translation for esp-ble-mesh, wifi, spi_flash and fata-errors; And keep line number consistency for en/index and versions 2022-01-07 16:05:16 +08:00
daiziyan a98212015f docs:update CN transalation for get-started section and sdmmc 2021-12-21 18:43:56 +08:00
daiziyan c82881eaee docs: update CN translation for vfs and nvs_flash 2021-12-10 17:02:47 +08:00
daiziyan c34ccb1bdf docs: update CN translation for fatfs.rst 2021-12-02 11:47:06 +08:00
Roland Dobai 9c1d4f5b54 Build & config: Remove the "make" build system
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
Shang Zhou 3ffc5f0c67 docs:update CN translation for API reference storage(fatfs and index) 2021-10-15 18:59:22 +08:00
Marek Fiala ff18a96f7d tools: replace _ with - in idf.py
Closes https://github.com/espressif/esp-idf/issues/5126
2021-10-13 17:30:38 +08:00
Ivan Grokhotkov 19a75177a8 docs: fix syntax errors in only:: blocks 2021-09-07 14:00:53 +08:00
Ivan Grokhotkov a005e9bfbc docs: move VFS documentation into the component directory
These files were added into the component directory back when we
didn't have the documentation directory, and weren't moved once the
documentation directory was created.
2021-08-23 07:02:19 +02:00
Cao Sen Miao fecf27e54c spi_flash: add support for 32Mbit address GD flash, for GD25Q256 2021-07-02 17:13:51 +08:00
Marius Vikhammer fd477fa60e docs: remove front page C3 docs not updated warning 2021-05-13 09:58:20 +08:00
Michael (XIAO Xufeng) 26585b4b4b esp_flash: support override default chip driver list 2021-04-26 16:05:42 +08:00
Michael (XIAO Xufeng) 925dacd7fb Merge branch 'bugfix/remove_HSPI_macro_on_c3' into 'master'
spi: remove HSPI macros on esp32c3 and esp32s3

Closes IDF-2535

See merge request espressif/esp-idf!12637
2021-04-08 09:33:18 +00:00
Armando 9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 2021-04-06 13:42:49 +08:00
daiziyan 540e9c57e4 docs:update CN translation for spiffs and touch_pad 2021-03-31 20:08:22 +08:00
Cao Sen Miao c54ea54d98 spi_flash: make suspend off by default and add more information for using suspend 2021-03-26 13:57:14 +08:00
Michael (XIAO Xufeng) 476fdcba68 spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND 2021-02-24 20:20:18 +08:00
Jakob Hasse 916f02164e [doc]: NVS documentation updates
* Move nvs flash README to common doc directory
* correct markup of functions and types in text
  from old README
* Better comment of nvs_get_used_entry_count()
* Mention C++ example in API reference
* Used target instead of hard code ESP32
* Note that strings can only span one page
* Reflect that item types have been moved
* Some clarification about nvs_commit()
* Improved reference to the ESP Partition API
* fixed little mistake in documenting-code.rst
* Change of nvs_open_from_part() to
  nvs_open_from_partition() reflected in docs
* Corrected documentation of
  NVSHandle::get_string(), NVSHandle::get_blob()
  and NVSHandle::get_item_size().

* Closes DOC-165
* Closes IDF-1563
* Closes IDF-859
* Closes https://github.com/espressif/esp-idf/issues/6123
2021-02-08 09:31:23 +08:00
daiziyan 3d2d0e2247 update CN translation for ulp-risc-v partition-table tips-and-quirks and idf-monitor for api-guides 2021-01-28 19:42:54 +08:00