OVMS3-idf/docs
Ivan Grokhotkov b540322dc1 Merge branch 'feature/wear_levelling' into 'master'
wear levelling

This MR adds wear levelling component. It presents an interface similar to the interface of spi_flash and esp_partition. Inside, it stores data inside a partition to in a way that reduces worst case number of erase cycles for any given sector.

Also included are APIs similar to the ones provided for SDMMC to mount FAT filesystem on top of the wear levelling partition. A simple example shows how this API can be used.

Ref TW10338.

See merge request !567
2017-04-25 19:46:11 +08:00
..
_static doc: Documenting Code clean up 2016-11-21 10:24:12 +08:00
api Merge branch 'feature/wear_levelling' into 'master' 2017-04-25 19:46:11 +08:00
security spi_flash: Fixed bug in SPI flash ROM driver to work with embedded flash chip 2017-04-11 10:51:19 +08:00
build-system.rst docs: Fix typo in build-system.rst 2017-03-03 14:59:15 +11:00
conf.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
contributing.rst Link to file a folder up 2016-11-01 01:20:04 +08:00
contributor-agreement.rst docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
COPYRIGHT.rst Add jsmn JSON parser component 2017-03-07 10:18:47 +11:00
core_dump.rst esp32: Fixed and updated core dump docs 2017-01-26 18:47:10 +03:00
deep-sleep-stub.rst Fixed section header style 2016-11-05 17:06:55 +01:00
documenting-code.rst docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
Doxyfile add wear_levelling component and example 2017-04-17 11:01:17 +08:00
doxygen_xml_to_rst.xslt rmt: add documentation 2016-11-22 01:44:23 +08:00
eclipse-setup-windows.rst Build system: Add new BATCH_BUILD flag to disable interactive parts of the build 2017-02-22 11:59:37 +11:00
eclipse-setup.rst docs/eclipse: Add considerations for PATH, PYTHONPATH 2017-03-03 15:33:23 +11:00
esp32.cfg Fix issued raised in the merge request 2016-08-30 11:30:03 +08:00
general-notes.rst docs: Improve/clarify partition, OTA & SPI flash docs 2017-02-20 15:31:42 +11:00
idf-monitor.rst idf_monitor: Small fixes (baud rate, EOL, /dev/tty.X on macOS, Ctrl-T on failure) 2017-03-21 16:00:32 +08:00
index.rst Merge branch 'feature/doc_boards_and_modules' into 'master' 2017-03-27 14:39:12 +08:00
link-roles.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
linux-setup.rst doc: Update manual for CentOS 2017-04-11 17:59:47 +08:00
macos-setup.rst docs: Mention the 'examples' dir in the setup docs 2017-03-27 11:02:49 +11:00
make-project.rst docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
Makefile docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
modules-and-boards.rst USB to serial driver links 2017-03-08 21:00:27 +01:00
openocd.rst Simplified "Installing OpenOCD" with git clone --recursive 2016-11-17 10:19:42 +11:00
partition-tables.rst docs: Improve/clarify partition, OTA & SPI flash docs 2017-02-20 15:31:42 +11:00
README.md Docs folder info, ref. https://github.com/espressif/esp-idf/issues/243; Doc title fix 2017-01-17 20:37:27 +01:00
repo_util.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
requirements.txt docs: fix typos, build docs with gitlab CI 2016-11-01 20:08:29 +08:00
style-guide.rst Fixed link so it can render by Sphinx 2016-11-10 22:44:59 +01:00
ulp.rst ulp: add build system integration and example 2017-03-27 12:41:00 +08:00
ulp_instruction_set.rst ulp: add build system integration and example 2017-03-27 12:41:00 +08:00
ulp_macros.rst ulp: add build system integration and example 2017-03-27 12:41:00 +08:00
unit-tests.rst esp32: add unit testing doc 2017-01-18 17:08:20 +08:00
windows-setup-scratch.rst doc: Fix some Windows Setup Guide links 2017-03-30 12:09:50 +11:00
windows-setup.rst docs: Fix Windows shell path in Step 4 2017-04-05 10:58:34 +10:00

Documentation Source Folder

This folder contains source files of ESP-IDF documentation.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated instantly on each commit: