15561c9e77
Merge branch 'doc/version_select' into 'master'
...
docs: Build new doc layout with theme from pypi test
Closes IDF-1972
See merge request espressif/esp-idf!9862
2021-03-16 05:05:17 +00:00
91439e3818
docs: updated system api-reference chapters for C3
2021-03-15 18:51:12 +08:00
85a016dbf6
api-guides: updated CN translation for unit-tests, jtag-debugging/index, and jtag-debugging/using-debugger
2021-03-15 13:01:15 +08:00
b3b559e75f
doc:updated cn translation for language.rst and version.rst to provide new layout for version/target select
2021-03-12 16:15:56 +08:00
6792024add
esp_common: add generic check macros
...
Add four check maros:
* ESP_RETURN_ON_ERROR()
* ESP_GOTO_ON_ERROR()
* ESP_RETURN_ON_FALSE()
* ESP_GOTO_ON_FALSE()
Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-11 17:38:22 +08:00
4f406d7a35
Merge branch 'bugfix/read_ota_partition_required_output_arg' into 'master'
...
otatool: Fixes read_ota_partition cmd, required output arg
Closes IDFGH-4756
See merge request espressif/esp-idf!12601
2021-03-09 06:29:34 +00:00
123e540b2f
update CN translation based on reviewers' comments
2021-03-09 10:28:52 +11:00
8c7fd31984
api-guides: update CN translation for build-system and build-system-legacy,and fix line break in the EN version
2021-03-09 10:28:52 +11:00
b7155a161b
otatool: Fixes read_ota_partition cmd, required output arg
...
Closes: https://github.com/espressif/esp-idf/issues/6559
2021-03-04 06:02:54 +00:00
ac776657c9
Merge branch 'docs/provide_link_to_pcb_layout_for_ethernet_board_v1.2' into 'master'
...
docs: provide the link to pcb layout for ethernet board v1.2 and fix a typo in freetos/task
See merge request espressif/esp-idf!12522
2021-03-02 11:42:59 +00:00
6334b5e56f
docs: update api-reference chapters for C3
...
Checked and updated the following chapters:
* api-reference/network
* api-reference/protocols
* api-reference/provisioning
* api-reference/storage
* api-reference/peripherals/ds
* api-reference/peripherals/hmac
* api-reference/peripherals/secure_element
2021-03-01 14:58:08 +08:00
776684fa84
docs: provide the link to pcb layout for ethernet board v1.2 and fix a typo in freetos/task
2021-02-26 10:35:21 +08:00
268289eade
Merge branch 'docs/spi_flash_auto_suspend' into 'master'
...
spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND
See merge request espressif/esp-idf!12290
2021-02-25 09:16:10 +00:00
a0eb455ec3
Merge branch 'refactor/misc_move_from_esp_common' into 'master'
...
Movements from esp_common
Closes IDF-1947
See merge request espressif/esp-idf!9692
2021-02-24 23:16:52 +00:00
84b33b9dba
Merge branch 'feature/update_efuse_doc' into 'master'
...
doc/efuse: Adds efuse doc for ESP32-C3
Closes IDF-2328
See merge request espressif/esp-idf!12365
2021-02-24 22:30:18 +00:00
c7f8001701
Merge branch 'feature/doc_update_security_chapters' into 'master'
...
doc/secure features: Updates doc esp32c3
Closes IDF-2322
See merge request espressif/esp-idf!12374
2021-02-24 22:28:36 +00:00
476fdcba68
spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND
2021-02-24 20:20:18 +08:00
f2561f6360
docs: update list of common component requirements
2021-02-24 12:16:37 +08:00
eb736985ef
Merge branch 'docs/esp32c3_fatal_errors' into 'master'
...
doc: update "Fatal Errors" chapter for ESP32C3 board
Closes IDF-2323
See merge request espressif/esp-idf!12437
2021-02-24 04:14:40 +00:00
33deabb3ab
doc: update "Fatal Errors" chapter for ESP32C3 board
2021-02-23 14:54:26 +08:00
70dd884fee
doc(esp32c3): Updates secure features doc
2021-02-22 18:01:35 +08:00
5a5f5ad031
doc/efuse: Adds efuse doc for ESP32-C3
2021-02-22 15:51:45 +08:00
78a1cd3643
touch_element: add touch element api-reference doc
2021-02-22 12:16:49 +08:00
8c729fb55b
docs: fix broken ref in external-ram.rst
2021-02-20 12:37:59 +08:00
97ec83fa78
Provide CN translation for get-started section in MR12242
2021-02-18 15:16:58 +01:00
9274abf5c9
Merge branch 'doc/nvs_get_used_entry_count__clarify' into 'master'
...
[doc]: NVS documentation updates
Closes IDF-1563, DOC-165, and IDF-859
See merge request espressif/esp-idf!12056
2021-02-18 10:36:16 +00:00
47f67f8b81
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-13 11:34:40 +01:00
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
aa2b3e1b01
Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS
2021-02-05 12:08:21 +08:00
5aaa0c9ca3
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +08:00
548fd02d10
docs: initial update of programming guide for C3
...
Updates "front page" content, get-started, and api-guides with C3 content
Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
3d2d0e2247
update CN translation for ulp-risc-v partition-table tips-and-quirks and idf-monitor for api-guides
2021-01-28 19:42:54 +08:00
1faff89ff6
Merge branch 'feature/update_jtag_translation' into 'master'
...
doc: update JTAG translation
Closes IDF-2069
See merge request espressif/esp-idf!12107
2021-01-27 10:37:10 +08:00
9a5bd86d54
Merge branch 'docs/update_docs_based_on_the_second_batch_of_customer_feedbacks' into 'master'
...
docs: update documents based on doc-855, doc-885, doc-889, doc-897
See merge request espressif/esp-idf!12124
2021-01-26 16:21:26 +08:00
4c31cf9804
docs: Update FreeRTOS version, add tips to set up instructions for Windows
2021-01-26 03:46:25 +00:00
7df1cad1d6
docs: This MR does the following updates:
...
1. Provided more information regarding I2S_COMM_FORMAT_STAND_PCM_SHORT and I2S_COMM_FORMAT_STAND_PCM_LONG
2. Added --output flag for partition table read instructions
3. Reordered the header files for esp-ble-mesh
4. Reordered the setup instructions for Ubuntu and CentOS
2021-01-25 11:10:08 +00:00
9788721de6
doc: update JTAG translation
2021-01-25 18:59:19 +08:00
a7da0c894b
Merge branch 'feature/c3_master_flash_enc_support' into 'master'
...
flash encryption: merge C3 flash encryption changes to master
See merge request espressif/esp-idf!12040
2021-01-22 12:58:38 +08:00
76acc8ddde
Merge branch 'feature/win_inst_embedded_python' into 'master'
...
tools: support for embedded Python
Closes IDF-322
See merge request espressif/esp-idf!11682
2021-01-18 16:54:47 +08:00
1427b3a6d8
tools: support for embedded python
2021-01-18 08:10:56 +01:00
03fa63b0c9
bootloader: add flash encryption support for C3
...
Adds flash encryption support for C3 and updates docs for S2 & C3
2021-01-18 14:10:54 +08:00
2e3367b97e
update api-guides/build-system.rst to keep EN and CN in sync
2021-01-13 19:23:30 +08:00
e2910d2ff5
doc: Add libusb package dependencies for Arch, CentOS
...
- Arch uses 'libusb' package, provides libusb-1.0.so
- CentOS has moved to 'libusbx', which is libusb-1 API compatible
Related to https://github.com/espressif/esp-idf/issues/4095
2021-01-13 05:15:27 +00:00
694dd2767a
update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section
2021-01-08 17:49:09 +08:00
703aef654b
provide user guide for ESP32-DevKitM-1
2021-01-05 12:32:08 +08:00
cf505d0ead
docs: update the documents based on customer feedbacks
2020-12-31 05:40:43 +00:00
7fe16bae25
tools: merge C3 changes into master
2020-12-30 07:04:12 +08:00
de798541dc
tools: use riscv32-esp-elf toolchain for ESP32-S2 RISC-V ULP
...
riscv32-esp-elf toolchain (used for ESP32-C3) can also be used for
ESP32-S2 RISC-V ULP coprocessor.
This removes the riscv-none-embed-gcc toolchain which was originally
used for the ULP, and updates the docs and CMake files to use
riscv32-esp-elf.
Some flags are cleaned up and workarounds removed from CMake toolchain
file.
2020-12-29 19:19:18 +00:00
da947d736f
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
8e4c73b1d1
Merge branch 'bugfix/minor_docs_fixes' into 'master'
...
minor docs fixes
See merge request espressif/esp-idf!11430
2020-12-21 11:31:00 +08:00
75c15293cc
update CN translation
2020-12-17 19:26:05 +08:00
37dc6044c3
docs: Add link to layout of ESP-WROVER-KIT board in DXF format
2020-12-17 19:26:05 +08:00
8dbd5a48a8
provide user guide for the development board ESP32-PICO-DevKitM-2
2020-12-14 18:26:44 +08:00
46cfc436ad
Merge branch 'feature/idf_tools_github_mirror' into 'master'
...
Add GitHub mirror option for IDF tools installs
Closes IDF-2028
See merge request espressif/esp-idf!10616
2020-12-14 15:58:51 +08:00
bdeb3a2fb6
upload user guide for development board: ESP32-PICO-KIT-1
2020-12-09 08:27:25 +00:00
0f3595b1e8
add CN translation for index.rst in get started section for MR10616
2020-12-07 16:36:37 +11:00
1c184bd0be
docs: ESP-IDF v4.2 fully supports ESP32-S2, remove documentation that describe preview support
2020-12-03 16:21:16 +08:00
5f5ae17bc8
Merge branch 'feature/python2-deprecation-warn' into 'master'
...
Tools: Add Python 2 deprecation warning
Closes IDF-1677
See merge request espressif/esp-idf!11115
2020-12-02 19:26:46 +08:00
11ae1dcebe
docs: fatal errors: mention another reason for LoadStoreError
2020-12-02 11:58:56 +01:00
33c414087b
add CN translation for adding python2 deprecation warning(MR 11115)
2020-12-02 11:11:57 +01:00
62f7a1b545
fix merge conflicts
2020-12-02 16:50:07 +08:00
5a2d84324d
docs: add ESP-IDF Windows Installation limitations.
2020-12-01 07:33:47 +01:00
b6645c7379
Merge branch 'doc/update_Chinese_translation_for_four_files_in_get-started_folder' into 'master'
...
updated Chinese translation for four files in get-started folder
See merge request espressif/esp-idf!10927
2020-11-30 18:06:10 +08:00
8b63b35005
updated Chinese translation for eclipse-setup linux-setup macos-setup and windows-setup to get EN and CN in sync
2020-11-30 18:06:05 +08:00
c7bebb0413
Doc/update CN translation for files on setting up toolchain from scratch in get started
2020-11-30 17:58:27 +08:00
82161dbdb5
Merge branch 'doc/update_Chinese_translation_for_index_in_get-started_folder' into 'master'
...
update CN translation for index & establish-serial-connection and add CN translation for VScode-setup to get EN and CN in sync
See merge request espressif/esp-idf!10903
2020-11-25 14:45:31 +08:00
c2818e775c
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
720e228dde
add a chinese translation for wifi driver
...
add the first part translated by joy
add the last part translated by huizi
solved some formatting issues and typos in en text
add updated cn translation based on peer review comments
updated based on technical review comments
add links to api functions
solve pipeline errors
convert line endings in cn file
solve some build errors
reedit a table
2020-11-20 10:33:04 +08:00
90c53b1a62
docs: Provide comparison of key features of ESP32 and ESP32-S2 chips
2020-11-16 19:08:24 +08:00
66fb5a29bb
Whitespace: Automated whitespace fixes (large commit)
...
Apply the pre-commit hook whitespace fixes to all files in the repo.
(Line endings, blank lines at end of file, trailing whitespace)
2020-11-11 07:36:35 +00:00
3882c2b8ed
Merge branch 'feature/bringup_esp32s3_fpga_update_rmt_driver' into 'master'
...
rmt: support esp32s3
Closes IDF-1773
See merge request espressif/esp-idf!10292
2020-11-07 07:15:53 +08:00
256333ca13
Merge branch 'ci/add_pre_commit_for_some_pre_check_jobs' into 'master'
...
CI: Add pre-commit for IDF project
See merge request espressif/esp-idf!10682
2020-11-06 20:16:27 +08:00
e9e6d970f3
Merge branch 'feature/add-shell-autocompletion' into 'master'
...
idf.py: Enable autocompletion for command idf.py
Closes IDF-1540
See merge request espressif/esp-idf!10742
2020-11-06 20:14:38 +08:00
f87cbdee28
Add ESP32-S2-DevKitM-1 User Guide
...
Update 1 based on comments
Fix typo
Add annotation to UFL connector
Add UFL connector to description table
2020-11-06 00:50:33 +00:00
1be923acb4
rmt: rename always_on to aware_dfs
2020-11-05 19:00:55 +08:00
346b002d9a
enable autocompletion for command idf.py
2020-11-03 23:27:58 +01:00
e8dc27add2
add contributing docs
2020-11-03 18:33:11 +08:00
79887fdc6c
soc: descriptive part occupy whole component
2020-10-28 07:21:29 +08:00
91cf7cc58d
doc: dedicated gpio api reference
2020-10-20 21:06:10 +08:00
840efc2f54
docs: describe power management logic for ESP32-S2, fix translation
2020-10-14 09:05:10 +02:00
46f735f413
Merge branch 'docs/update-images-for-ide' into 'master'
...
Update docs images
Closes VSC-431
See merge request espressif/esp-idf!10639
2020-10-09 15:05:06 +08:00
ba901179fe
Update docs images
2020-10-09 15:05:01 +08:00
e0261f18ce
Merge branch 'feature/add_esp_rom_printf_to_api_reference' into 'master'
...
docs: Add esp_rom_printf to API Reference
Closes DOC-454
See merge request espressif/esp-idf!10251
2020-10-09 04:06:10 +08:00
20af94ff53
Coredump config option rename throughout IDF
2020-09-30 20:22:27 +05:30
2e826b7a8f
intr_alloc: split interrupt allocator into common-code and platform-code
...
esp_system: removed repeated interrupt allocator code and moved common code to esp_system
xtens: moved xtensa specific code from freertos to the xtensa component
hal/interrupt_controller: added interrupt controller hal and ll files
docs: update the doxyfile with new location of esp_itr_alloc.h file
xtensa: fixed dangerous relocation problem after moving xtensa interrupt files out of freertos
docs: removed Xtensa reference from intr_allocator api-reference
xtensa: pushed the interrupt function that manages non iram interrupts to the xtensa layer
esp_system/test: fixed platform dependent setting for intr_allocator tests
hal: rename the functions used to manage non iram interrupt mask.
2020-09-30 07:44:12 +08:00
068690e604
Merge branch 'docs/fix_formatting_issues_in_idf_monitor' into 'master'
...
docs: fix formatting issues in api-guides
Closes DOC-489, DOC-406, and DOC-487
See merge request espressif/esp-idf!10459
2020-09-24 15:30:33 +08:00
00a99cfb9d
docs: fix formatting issues in api-guides
2020-09-24 15:30:28 +08:00
50e79e6763
Merge branch 'feature/switch_to_kconfiglib_package' into 'master'
...
tools: Use kconfiglib from package
Closes IDF-989
See merge request espressif/esp-idf!10535
2020-09-24 12:27:31 +08:00
883cbc416e
tools: Use kconfiglib from package
2020-09-22 11:29:30 +02:00
9fa06719fa
global: enable build uinit test for esp32-s3
2020-09-22 15:15:03 +08:00
b686e7d349
doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions
2020-09-11 01:43:21 +08:00
db0c6d7921
docs: Add esp_rom_printf to API Reference
2020-09-10 22:55:43 +08:00
2d4e0a4496
docs: Add explanation of hello_world folder contents
2020-09-10 22:29:24 +08:00
22301653c6
VSCode Extension Setup Guide
2020-09-02 00:07:31 +08:00
94cc8fc4b3
Merge branch 'doc/tinyusb' into 'master'
...
TinyUSB documentation
See merge request espressif/esp-idf!8862
2020-08-31 20:57:29 +08:00
4c4b25f391
Merge branch 'docs/add_instructions_to_create_esp_folder_before_clone_esp-idf' into 'master'
...
Add a command to create an esp directory before cloning esp-idf DOC-346
Closes DOC-346
See merge request espressif/esp-idf!10003
2020-08-31 20:46:02 +08:00
634482953d
Merge branch 'docs/update_the_module_list_available_for_esp32-devkitc' into 'master'
...
Update the module list available for ESP32-DevKitC V4 development board
Closes DOC-422
See merge request espressif/esp-idf!10137
2020-08-31 18:37:33 +08:00
a5e5794059
docs: add a command to create an esp directory before cloning esp-idf
2020-08-31 09:12:21 +00:00
a0d0971101
Merge branch 'doc/remove_lts_versions' into 'master'
...
docs: Update Versions file in line with the latest Support Policy document
Closes IDF-2037
See merge request espressif/esp-idf!10168
2020-08-31 15:41:02 +08:00
f92433b946
Merge branch 'bugfix/get_started_inconsistency' into 'master'
...
docs: Add missing target setting in step 7 of Getting Started documentation
Closes IDFGH-3863
See merge request espressif/esp-idf!10127
2020-08-28 20:23:17 +08:00
Krzysztof Budzynski