alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
f8b9cb2864
esp-idf/docs
History
Angus Gratton f8b9cb2864 paritition_table: Verify the partition table md5sum when loading the app 
Additionally, always enable the partition MD5 check if flash encryption is on in
Release mode. This ensures the partition table ciphertext has not been modified
(CVE-2021-27926).

The exception is pre-V3.1 ESP-IDF bootloaders and partition tables, which
don't have support for the MD5 entry.
2021-06-02 06:35:45 +00:00
..
_static TWAI: Add ESP32-S2 support 2020-07-30 22:09:39 +08:00
en paritition_table: Verify the partition table md5sum when loading the app 2021-06-02 06:35:45 +00:00
extensions doc: custom list filter directive 2020-02-20 18:08:05 +08:00
idf_extensions build system: Also get IDF version from annotated tags only 2020-10-07 13:58:21 +11:00
latex_templates doc: add latex and PDF generation to build_docs 2020-04-15 17:14:22 +08:00
zh_CN docs: add RF calibration docs for ESP32-S2 2021-05-26 10:58:38 +08:00
build_docs.py docs: Update Versions file in line with the latest Support Policy document 2020-09-25 09:59:56 +10:00
check_lang_folder_sync.sh global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs 2020-04-03 01:10:02 +02:00
conf_common.py docs: add RF calibration docs for ESP32-S2 2021-05-26 10:58:38 +08:00
Doxyfile docs: fix doxygen compile warnings for doxygen 1.9.1 2021-05-05 18:14:19 +08:00
doxygen-known-warnings.txt docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
get_github_rev.py docs: add 'edit-on-github' link to html theme 2020-05-06 17:25:23 +08:00
page_redirects.txt docs: repurpose WROVER-KIT debugging guide for Kaluga-1 2020-09-04 21:59:05 +02:00
README.md docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-03-16 14:36:23 +11:00
requirements.txt docs: update sphinx_idf_theme documentation 2020-07-06 10:55:32 +08:00
sanitize_version.py docs: deploy docs to production server from CI 2020-03-16 14:36:23 +11:00
sphinx-known-warnings.txt docs: fix check_docs not working for multiple builders 2020-07-06 12:27:02 +08:00
TEMPLATE_EXAMPLE_README.md examples: Update system examples README 2019-08-28 16:19:40 +08:00

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation available in English and 中文.

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

Use actual documentation generated within about 20 minutes on each commit:

Hosted Documentation

The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.

Building Documentation

The documentation build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.

See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.