Commit Graph

912 Commits

Author SHA1 Message Date
Sergei Silnov
5717288cd7 docs: Add component manager documentation 2022-01-27 18:57:52 +01:00
Jakob Hasse
908dbe0595 [doc]: NVS documentation updates
* Better comment of nvs_get_used_entry_count()
* Mention C++ example in API reference
* WIP: 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 IDF-1563
* Closes IDF-859
* Closes https://github.com/espressif/esp-idf/issues/6123
2021-12-17 16:13:23 +08:00
Alexey Gerenkov
ba03d9f55b docs: Fixes OpenOCD debug level option 2021-11-25 09:38:48 +01:00
Wang Fang
7dc5375867 docs: Fix ADC pad and MOSI typo, update esp32c3 rom elf link 2021-09-14 11:30:50 +08:00
Zim Kalinowski
6d876a8677 Merge branch 'bugfix/read_ota_partition_required_output_arg_v4.1' into 'release/v4.1'
otatool: Fixes read_ota_partition cmd, required output arg (v4.1)

See merge request espressif/esp-idf!13674
2021-08-12 21:30:20 +00:00
Krzysztof Budzynski
49e5961ec5 Merge branch 'docs/fix_UART_default_pin_error_and_provide_a_link_to_ESP_PROG_v4.1' into 'release/v4.1'
docs: fix uart default pin error and provide more information about ESP-Prog board (v4.1)

See merge request espressif/esp-idf!13970
2021-07-23 11:19:01 +00:00
Wang Fang
2df08f3445 docs: Correct uart default pin names and provid more information about ESP-Prog board 2021-07-20 17:11:54 +08:00
KonstantinKondrashov
1c54276021 otatool: Fixes read_ota_partition cmd, required output arg
Closes: https://github.com/espressif/esp-idf/issues/6559
2021-07-15 11:15:36 +08:00
Juraj Michálek
1738f01c10 docs: update Windows Tools 2.9 installation 2021-06-30 12:47:51 +02:00
Krzysztof Budzynski
ac5511972f Merge branch 'bugfix/make_docs_ldgen_v4.1' into 'release/v4.1'
docs: remove quotes in ldgen documentation for adding fragment file (v4.1)

See merge request espressif/esp-idf!14002
2021-06-18 08:44:21 +00:00
Renz Bagaporo
c97984de99 docs: remove quotes in ldgen documentation for adding fragment file
Closes https://github.com/espressif/esp-idf/issues/5142
2021-06-17 09:13:40 +02:00
Wang Fang
b9ca1e9b48 docs: update the documents based on customer feedbacks 2021-06-15 14:54:11 +08:00
Angus Gratton
7e0abf78f9 Merge branch 'bugfix/partition_table_integrity_check_v4.1' into 'release/v4.1'
paritition_table: Verify the partition table md5sum when loading in the app (v4.1)

See merge request espressif/esp-idf!13584
2021-06-02 08:54:01 +00:00
Angus Gratton
8d1a99e026 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 16:31:19 +10:00
Angus Gratton
e836297b55 Merge branch 'feature/idf_tools_github_mirror_v4.1' into 'release/v4.1'
Add GitHub mirror option for IDF tools installs (v4.1)

See merge request espressif/esp-idf!13766
2021-06-01 09:48:12 +00:00
Angus Gratton
97b6b435a8 docs: Remove some uses of IDF_TARGET_NAME accidentally backported 2021-05-31 11:09:05 +10:00
Angus Gratton
fd91bf4500 tools: Use GitHub download URLs for all files that can be downloaded from GitHub 2021-05-31 11:06:19 +10:00
Angus Gratton
f99c367e5d idf_tools: Add option to replace all GitHub tools download URLs with dl.espressif.com
Via new IDF_GITHUB_ASSETS environment variable.
2021-05-31 11:06:19 +10:00
David Cermak
bd3de5c295 lwip: Add docs about not supported delete of task while blocked on select 2021-05-24 15:11:09 +02:00
daiziyan
9fe035e4f5 docs:update CN translation for build-system,ulp,unit-tests,and idf-monitor for v4.1 2021-04-27 09:39:01 +00:00
Marius Vikhammer
7e839a82de docs: fix doxygen compile warnings for doxygen 1.9.1
Newer versions of doxygen will give warnings for comments in
INPUT lists

Delete all comment lines to fix these warnings, our folder structure
stil gives an OK overview of what we are including
2021-04-12 08:44:06 +08:00
dongyou
87968f8406 esp_wifi: Add documentation to avoid using WiFi modem sleep for WiFi/BT coexistence
Remove description of unusable API esp_wifi_restart()
Update esp_now_fetch_peer discription
Update description for ssid and password
2021-03-17 15:27:25 +08:00
Darian Leung
fb2d6a44eb CAN: ISR runs when cache is disabled
This commit adds the feature where the CAN ISR will continue to
run even if the cache is disabled. Whilst cache is disabled, any
received messages will go into the RX queue, and any pending TX
messages in the TX queue will be transmitted. This feature should
be enabled using the CONFIG_CAN_ISR_IN_IRAM option.
2021-03-09 08:47:58 +08:00
Krzysztof Budzynski
da1ed49a65 Merge branch 'docs/fix_broken_example_links_for_releasev4.1' into 'release/v4.1'
docs: fix broken example links for release v4.1

See merge request espressif/esp-idf!12503
2021-03-08 08:22:04 +00:00
Wang Fang
90118531a7 docs: fix broken example links for release v4.1 2021-02-25 13:41:04 +08:00
Marius Vikhammer
10311644e4 docs: remove RTD download PDF links
PDF download is available from the version selector menu.
Read the docs links are out of date.
2021-02-23 11:46:06 +08:00
Roland Dobai
52ecfeb337 tools: Prefer python3 during install and export
Install and export script should work on systems without "python"
executable.

Closes https://github.com/espressif/esp-idf/pull/6471

Closes https://github.com/espressif/esp-idf/issues/6532

Related to https://github.com/espressif/esp-idf/issues/6421 and
https://github.com/espressif/arduino-esp32/issues/4717
2021-02-14 19:46:28 +01:00
Angus Gratton
5b3734a04a efuse: Add ESP32 V3 'disable Download Mode' functionality 2020-12-16 17:08:04 +11:00
Krzysztof Budzynski
3217cd4734 Merge branch 'doc/update_CN_translation_for_relase/v4.1' into 'release/v4.1'
update get-started/index.rst for release/v4.1

See merge request espressif/esp-idf!11513
2020-12-11 11:38:41 +08:00
Dai Zi Yan
37d8033906 update get-started/index.rst for release/v4.1 2020-12-11 11:38:37 +08:00
daiziyan
026accbb91 add CN translation for adding python2 deprecation warning(MR 11115) 2020-12-09 14:41:33 +01:00
martin.gano
f75acede24 Tools: add Python 2 deprecation warning 2020-12-09 14:41:33 +01:00
Wang Fang
753eaa03a6 docs: fix a broken link for v4.1 2020-11-23 15:46:01 +08:00
Angus Gratton
65f1be59ad Merge branch 'bugfix/idf_py_disable_cmake_warnings_default_v4.1' into 'release/v4.1'
idf.py: disable cmake uninitialized variable warnings by default (v4.1)

See merge request espressif/esp-idf!10202
2020-10-19 06:34:15 +08:00
Krzysztof
3bca931923 docs: Add profile file name used by zsh shell 2020-10-09 19:16:59 +02:00
Victor Lamoine
ccfe70872e Fix ccache documentation: environment variable is IDF_CCACHE_ENABLE
Merges https://github.com/espressif/esp-idf/pull/5753
2020-10-05 05:35:02 +00:00
Angus Gratton
aecb2bd8ee idf.py: Disable CMake --warn-uninitialized option by default
Can still be enabled by passing --cmake-warn-uninitialized on the command line

Prevents CMake warnings printed by default if IDF_PATH is underneath the CMake
project directory.

The reason for this is that CMake --warn-uninitialized only enables checks
inside the project directory (ie top-level CMakeLists.txt directory and
subdirectories), it doesn't enable for files included from other directories.

(The only way to enable warnings in other directories is to pass
--check-system-dirs and this looks like it's only useful for CMake's own
developers as it prints a lot of warnings from inside CMake otherwise - see
https://gitlab.kitware.com/cmake/cmake/-/issues/19645 )

Plan to follow up with a later commit to clean up most of the warnings (which
aren't problems for CMake execution), but we'll also disable this option by
default to avoid this unexpected triggering of IDF warnings.
2020-10-05 05:35:02 +00:00
martin.gano
c44bc3752f docs: add description of python-clean command 2020-09-27 00:03:56 +02:00
Krzysztof Budzynski
5a0ee17ae2 Merge branch 'bugfix/remove_shortcut_to_build_instructions_v4.1' into 'release/v4.1'
doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions (v4.1)

See merge request espressif/esp-idf!10607
2020-09-25 21:04:49 +08:00
Krzysztof
83482b8912 doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions 2020-09-25 16:05:49 +08:00
Angus Gratton
dab3d1750e docs: Update Versions file in line with the latest Support Policy document 2020-09-25 10:12:56 +10:00
Angus Gratton
5f5a398662 Merge branch 'backport/shared_stack_4.1' into 'release/v4.1'
Backport/shared stack 4.1

See merge request espressif/esp-idf!10302
2020-09-18 05:15:30 +08:00
Anton Maklakov
e1ad627a0f docs: Fixup format of a command line to build unit tests 2020-09-15 16:21:44 +10:00
Felipe Neves
10c498ae7d expression_with_stack: added a tweak on TCB stackpointers to avoid false trigger of stack overflow 2020-09-10 10:00:32 -03:00
Roland Dobai
7da1603a1c Fix the setup instructions in the main README 2020-09-08 10:15:15 +02:00
Felipe Neves
124ec431e6 test/shared_stack_printf: improved printf with shared stack function test 2020-09-04 16:03:51 -03:00
Krzysztof Budzynski
c47cbe8139 Merge branch 'docs/doc138_backport_v4.1' into 'release/v4.1'
Fix incorrect redirect link in getting started guide (backport v4.1)

See merge request espressif/esp-idf!9719
2020-08-22 00:38:37 +08:00
Krzysztof Budzynski
d2fd9c10b3 Merge branch 'doc/freertos_backport_v4.1' into 'release/v4.1'
add a note about ESP-IDF FreeRTOS version (backport v4.1)

See merge request espressif/esp-idf!9811
2020-08-22 00:18:25 +08:00
He Yin Ling
a3f71eeeb4 Merge branch 'test/merge_ble_mesh_node_and_provioner_in_console_v4.1' into 'release/v4.1'
Test:merge ble mesh node and provioner in console (backport v4.1)

See merge request espressif/esp-idf!9912
2020-08-21 20:00:34 +08:00
Lu Chang Jie
3512a775bc Test:merge ble mesh node and provioner in console 2020-08-21 20:00:32 +08:00