Commit Graph

31 Commits

Author SHA1 Message Date
renpeiying
0a3f2d7ff2 docs(nvs_flash): update CN translation 2026-08-14 09:25:24 +02:00
sonika.rathi
5394a30873 docs(nvs_flash): add C++ NVS handle API documentation
Closes https://github.com/espressif/esp-idf/issues/10283
2026-08-13 15:42:18 +08:00
Marius Vikhammer
4d332f710e docs(kconfig): update kconfig ref links to use menuitem 2026-08-11 11:19:45 +02:00
Zhang Shuxian
f9ba81e396 docs: Update CN translation for nvs_flash.rst 2026-08-03 11:39:48 +08:00
radek.tandler
a5443bbb94 feat(nvs_flash): Added support for storing flash and double types
- added backward compatibility test for unknown NVS entry types
 - axtended documentation with the support of double and float
2026-03-31 19:02:43 +02:00
Zhang Shuxian
38fea8472a docs: Update CN translation for nvs_flash 2026-03-23 16:35:56 +08:00
radek.tandler
d50c7b4b6b feat(nvs_flash): Added purging of erased items at namespace level
- Added new option NVS_READWRITE_PURGE for nvs_open. All update and erase operations of
    the handle are wiping out the content erased items on top of just marking them erased.
  - Added new API call nvs_purge_all allowing to wipe out the existing erased items
    of the handle.
2026-02-05 11:07:43 +01:00
Zhang Shuxian
1ae27538a0 docs: Update translation for flash erase 2026-01-13 11:22:16 +08:00
Zhang Shuxian
f13c16e031 docs: Update CN translation for NVS statistics example 2025-11-10 12:18:31 +01:00
sonika.rathi
b077caeebc refactor(examples/storage): update document links 2025-04-03 14:21:11 +02:00
renpeiying
674ad565f8 docs: Update CN translation for 2 api files 2025-03-27 15:50:27 +08:00
radek.tandler
c445ec134b feat(nvs_flash): Implemented basic nvs_flash support for bootloader 2024-11-14 11:56:45 +01:00
radek.tandler
ffaf1d2968 feat(nvs_flash): Added Kconfig option contolling NVS heap allocation source
NVS configuration is extended with Kconfig option controlling RAM area for
NVS heap allocation. Either Internal RAM or SPIRAM can be chosen.
Tests were extended to check memory consumption from Internal and SPIRAM pool with respect
to the Kconfig option chosen.
Documentation was extended with notes related to NVS behavior in various situations.
2024-06-06 08:25:51 +02:00
radek.tandler
e8992f500c fix(nvs_flash): nvs_set with same key and different data type
Function now always rewrites old value under same key
regardless existing data type. Users requiring old API behaviour
can enable it by kconfig option CONFIG_NVS_LEGACY_DUP_KEYS_COMPATIBILITY
2023-09-26 15:05:20 +00:00
caixinying-git
10a625a7cb docs: update format issues left in CN docs 2023-09-15 17:51:12 +08:00
Shang Zhou
6c2fb57df8 docs: update CN translation for nvs_flash.rst 2023-08-10 14:27:12 +08:00
caixinying-git
a67b37330d docs: update format issues for EN and CN files under api-reference/provisioning and api-reference/storage 2023-07-24 17:21:09 +08:00
Wang Zi Yan
3e4152cdcf docs: Update CN for nvs_flash.rst and flash-encryption.rst 2023-07-14 04:05:53 +00:00
Linda
65ee4992ce docs: update the algorithm and key name from AES-XTS to XTS-AES 2023-05-15 17:54:50 +08:00
Mo Fei Fei
49c38f16e8 Docs: Update cn trans for nvs_flash and spi_flash_concurrency 2022-11-01 16:39:54 +08:00
Mo Fei Fei
a6e92beda3 Docs: Update CN trans for nvs_flash.rst 2022-09-01 17:45:11 +08:00
Shang Zhou
ea26e6a635 docs: Update CN version for MR19453 2022-08-15 16:14:14 +08:00
intern
4866e91398 docs: update nvs encryption cn trans 2022-07-18 14:40:56 +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
daiziyan
c82881eaee docs: update CN translation for vfs and nvs_flash 2021-12-10 17:02:47 +08: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
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
Angus Gratton
e6211c7864 docs: add new top-level docs builder that builds docs for a single chip 2020-02-07 16:37:43 +11:00
Wang Fang
32adfdc307 Add Chinese translation for the 2nd batch of the files in storage folder in api-reference.
1. The translation should be first reviewed by technical reviewers;
2. and then by language reviewers.

For the translation for the first batch of files, please see !MR5620 and !MR5613
2019-09-20 12:32:55 +08:00
krzychb
097adc3a33 Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00