Historia

xueyunfei 00096a3433 lwip: Add security fixes and other features and bufixes to v4.2 * Update submodule: git log --oneline 2195f7416fb3136831babf3e96c027a73075bd4f..6bb132e3797d5449a923804c75c57d458920f8ac Detailed description of the changes: - tcp_in/ooseq: Fix incorrect segment trim when FIN moved (espressif/esp-lwip@6bb132e3) - api_msg: fix tcp_abort thread safety (2.1.2-esp) (espressif/esp-lwip@53a6e019) - lwip:optimization dhcp coarse timer (espressif/esp-lwip@a7abf28e) - napt: Fix ip_portmap_add() to keep only one port mapping (espressif/esp-lwip@abab9fef) - reduce the DHCP Request timeout (espressif/esp-lwip@6fa02bd3) - lwip timer:optimization dhcp fine timer (espressif/esp-lwip@79182163) - optimization lwip ip4 reassembly timer (espressif/esp-lwip@17f41c9f) - optimization lwip ip6 reassembly timer (espressif/esp-lwip@c943fc5a) - optimization lwip dns timer (espressif/esp-lwip@7f5ab42c) - napt: Fix clean compilation (espressif/esp-lwip@6132c975) - Lwip:add TCP Fin2 timeout configuration (espressif/esp-lwip@15b4400e) - napt: Fix IP forwarding when forward netif enable NAPT (espressif/esp-lwip@c950063f) - napt/stats: Move some napt counters to stats module (espressif/esp-lwip@475d658a) - ip_napt_maint: Fix timestamp overflow handling (espressif/esp-lwip@2e904508) - napt: Fixes and improvements (espressif/esp-lwip@fb1f3552) - test/napt: Add unit test for IP forward with PBUF_REF (espressif/esp-lwip@76303df2) - napt: Fix PBUF_REF type to clone the pbuf before forwarding (espressif/esp-lwip@39068263) - version: Update version numbers to match 2.1.2-esp (espressif/esp-lwip@2b922919) - pppos: fix in_tail null (espressif/esp-lwip@537c69d5) - PPP: Add test exhibiting empty packet null-deref (espressif/esp-lwip@202a07da) - pbuf: Add pbuf_copy_partial_pbuf library function (espressif/esp-lwip@1c9cd9c1) - Add #define for minimum IPv6 MTU length (espressif/esp-lwip@d2dc577b) - zepif: Copy possibly chained output pbuf properly (espressif/esp-lwip@64ab7f2a) - icmp6: Don't copy too much data (espressif/esp-lwip@4a64731b) - icmp6: Fix copying of chained pbuf in reply (espressif/esp-lwip@7c822ff4) - icmp6: keep to the RFC and send as much as possible with icmp6 error messages (espressif/esp-lwip@29100ab6) - dns: Add API to clear dns cache (espressif/esp-lwip@ee59f77d) - CI: Fixed adding gitlab key (espressif/esp-lwip@5a2bdba7) - test case: modify test case test_tcp_new_max_num_remove_FIN_WAIT_1 (espressif/esp-lwip@6b090f7d) - add function for deinit lwip timers (espressif/esp-lwip@2749568f) - dhcp: Fix build issue that set ESP_DHCP_DISABLE_VENDOR_CLASS_IDENTIFIER to true will build fail (espressif/esp-lwip@d827dbf7) - Document that sntp_setservername doesn't copy the string (espressif/esp-lwip@54acdb59) - Closes https://github.com/espressif/esp-idf/issues/6786 - lwip/dhcp: add 60 option for vendor class identify (espressif/esp-lwip@ae7edc2a) - Closes https://github.com/espressif/esp-lwip/issues/32 - dhcp: Restore dhcp_cb on restart after dhcp_release_and_stop() (espressif/esp-lwip@55ea9d9c) - Closes https://github.com/espressif/esp-idf/issues/7217 - napt: Fix disbale IPv6 and enable NAPT will build error (espressif/esp-lwip@74cf7f9f) - napt: fix checksum of UDP (espressif/esp-lwip@bb63eed1) - sntp: Fix client receive KOD packet that make pool MEMP_SYS_TIMEOUT not be freed (espressif/esp-lwip@1c1642fe) - test case: add tcp state and reset test cases. (espressif/esp-lwip@67deb805)		2023-06-05 06:08:45 +00:00
..
_static	docs/update_esp32-s2_devkit_user_guides	2021-09-22 19:12:28 +08:00
en	lwip: Add security fixes and other features and bufixes to v4.2	2023-06-05 06:08: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	Update the ESP-NOW frame length in docs	2023-04-10 17:21:59 +08:00
Doxyfile	docs: change some header path to use IDF_TARGET	2022-01-07 11:16:30 +08: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
TEMPLATE_EXAMPLE_README.md	examples: Update system examples README	2019-08-28 16:19:40 +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
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
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

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.