Commit Graph

1228 Commits

Author SHA1 Message Date
Cai Xin Ying
2fac98d2e0 docs:update format issues for files under api-guides 2023-09-07 15:26:05 +08:00
caixinying-git
d0abcaf0ad docs: provide CN translation for api-guides/wifi-security.rst 2023-09-07 14:21:07 +08:00
Jakub Kocka
e265c1f387 docs(docker): Update Using Remote Serial Port chapter
By default some shells such as zsh has NOMATCH option set (https://zsh.sourceforge.io/Doc/Release/Options.html).
The root cause of the problem is that while bash expands the parameter to itself if it does not match any filename, the zsh reports an error. IOW if we do % setopt nonomatch it will work even in zsh.

Closes https://github.com/espressif/esp-idf/issues/12060
2023-09-06 11:26:47 +02:00
Adam Múdry
2b5d12858d Merge branch 'docs/partition_table_api_guide_update_data_subtypes' into 'master'
docs(storage): Add supported data partition subtypes

Closes IDF-818

See merge request espressif/esp-idf!25614
2023-09-06 15:31:39 +08:00
Mo Fei Fei
e4b7dd371c Docs: update Chinese translation for partition table data subtypes 2023-09-06 11:19:54 +08:00
Jiang Jiang Jian
72a8f37723 Merge branch 'feature/update_h2_wifi_docs' into 'master'
feat(doc): update wifi sections for H2

See merge request espressif/esp-idf!25662
2023-09-06 10:20:46 +08:00
Roland Dobai
f28daac734 Merge branch 'feature/add_cn_to_idf_github_assets' into 'master'
feat(tools): Add dl.espressif.cn IDF_GITHUB_ASSET to documentation

Closes IDF-8065

See merge request espressif/esp-idf!25613
2023-09-05 18:01:27 +08:00
Krzysztof Budzynski
5325cb5a9f Apply 1 suggestion(s) to 1 file(s) 2023-09-05 17:26:52 +08:00
morris
b4c7b13ce9 Merge branch 'docs/add_Chinese_translation_for_api-guides/lwip.rst' into 'master'
docs: provide CN translation for api-guides/lwip.rst

Closes DOC-5300

See merge request espressif/esp-idf!24002
2023-09-05 11:15:48 +08:00
Cai Xin Ying
065307fb84 Merge branch 'docs/add_Chinese_translation_for_api-guides/cplusplus.rst' into 'master'
docs: provide CN translation for api-guides/cplusplus.rst

Closes DOC-5460

See merge request espressif/esp-idf!24239
2023-09-04 22:14:10 +08:00
Nic Ballinger
f5450ca530 fix(docs/jtag): Fix hard-coded HW breakpoints/watchpoints number
Closes https://github.com/espressif/esp-idf/pull/11986
2023-09-04 15:40:04 +03:00
caixinying-git
6ee5bbf3a6 docs: provide CN translation for api-guides/lwip.rst 2023-09-04 17:46:22 +08:00
Xu Xiao
8847eeec0c feat(wifi): optimize esp32c6 iperf performance 2023-09-04 14:34:54 +08:00
caixinying-git
7c560c61c3 docs: provide CN translation for api-guides/cplusplus.rst 2023-09-01 11:02:36 +08:00
xuxiao
4701aa1589 feat(doc): update wifi sections for H2 2023-08-31 19:27:51 +08:00
Cai Xin Ying
e0f5d3c527 Merge branch 'docs/add_Chinese_translation_for_api-guides/core_dump.rst' into 'master'
docs:provide CN translation for api-guides/core_dump.rst and api-guides/core_dump_internals.rst

Closes DOC-5457

See merge request espressif/esp-idf!24197
2023-08-31 16:50:52 +08:00
Cai Xin Ying
18c2bb0a6f docs:provide CN translation for api-guides/core_dump.rst and api-guides/core_dump_internals.rst 2023-08-31 16:50:52 +08:00
Rocha Euripedes
acbcdc0487 Merge branch 'clarification_on_rtc_fast' into 'master'
docs: Makes the description for RTC fast as heap explicit

See merge request espressif/esp-idf!25103
2023-08-31 16:21:21 +08:00
Marek Fiala
608b6e5480 feat(tools): Add dl.espressif.cn IDF_GITHUB_ASSET to documentation 2023-08-31 07:46:36 +00:00
Cai Xin Ying
9684acc482 Docs: provide CN translation for the rest docs of api-guides/tools 2023-08-29 23:10:06 +08:00
Adam Múdry
087de4c77a docs(storage): Add supported data partition subtypes 2023-08-29 11:28:28 +02:00
Sudeep Mohanty
ec4cd2bb19 docs(freertos): Updated FreeRTOS documentation for ESP32-P4 2023-08-28 10:07:43 +08:00
aditi_lonkar
c88e7106ec esp_wifi: Make enterprise support configurable to save binary size. 2023-08-25 11:00:54 +05:30
mofeifei
3035856381 docs: update cn trans for memory-types 2023-08-25 11:43:39 +08:00
Radim Karniš
e3eb2ea9cc Merge branch 'docs/uninstall_idf' into 'master'
docs(idf-tools): Add uninstallation instructions

Closes IDFGH-9768

See merge request espressif/esp-idf!25313
2023-08-23 05:03:51 +08:00
Jiang Jiang Jian
514d9a8594 Merge branch 'docs/update_wifi_and_wpa_supplicant_documentation' into 'master'
Docs: Update wifi and wpa_supplicant documentation

See merge request espressif/esp-idf!24029
2023-08-22 19:29:37 +08:00
caixinying-git
a876c2d888 docs: provide CN translation for api-guides/usb-serial-jtag-console.rst 2023-08-22 11:06:12 +08:00
Shang Zhou
00fe2a6166 docs: Update CN translation for idf-tools.rst and get-started/index.rst 2023-08-21 15:34:26 +02:00
radim.karnis
e2638a2af0 docs(idf-tools): Add uninstallation instructions
Closes https://github.com/espressif/esp-idf/issues/11102
2023-08-21 15:32:27 +02:00
Shreyas Sheth
043b8b55a1 docs(wifi): Update wifi and wifi security documentation
1. Update documentation for WPA3 Enterprise and WPA3 Enterprise 192-bit
mode
2. Update documentation for WPA3 OWE and OWE transition mode
3. Update documentation related to SAE PK, SAE PWE and Transition Disable
4. Update documnetation for wifi connect API
5. Fix config paramter information for wifi scan start
6. Fix documentation related to scan threshold config setting
7. Replace ESP_ERR_WIFI_ARG error code as ESP_ERR_INVALID_ARG
8. Update documentation for 802.11R Fast transition
2023-08-21 12:29:11 +00:00
Roland Dobai
3adee7ecf6 Merge branch 'contrib/github_pr_11987' into 'master'
idf-docker-image.rst: Run with current user ID instead of root. (GitHub PR)

Closes IDFGH-10773

See merge request espressif/esp-idf!25146
2023-08-21 13:16:59 +08:00
daiziyan
1c2a8a8917 docs: provide CN trans for idf-docker-image 2023-08-18 15:40:26 +02:00
Ivan Grokhotkov
1c90dd3057
docs: fix DFU subsections showing up in main TOC 2023-08-17 15:46:52 +02:00
Euripedes Rocha
c79d1afb24 docs: Makes the description for RTC fast as heap explicit
Makes it explicit that to use rtc memory fast as heap,
ESP32 needs to be configured in single core mode.
2023-08-17 15:07:00 +02:00
Yi Ying
d8b34c739a Merge branch 'docs/add_bluetooth_overview_page' into 'master'
docs: add bluetooth overview

Closes DOC-5644

See merge request espressif/esp-idf!25030
2023-08-16 19:02:16 +08:00
Marius Vikhammer
27baef2424 docs(esp32p4): added building docs for ESP32-P4 2023-08-16 10:13:47 +08:00
Yi Ying
eafbd37e8f docs (Bluetooth): add bluetooth overview document 2023-08-15 11:13:14 +08:00
Roland Dobai
4bbc57cd37 Merge branch 'update/deprecate_python37' into 'master'
feat: Drop Python 3.7 support

Closes IDF-4441

See merge request espressif/esp-idf!24897
2023-08-08 23:30:12 +08:00
radim.karnis
8acde05a5c feat: Drop Python 3.7 support 2023-08-08 08:37:29 +02:00
Jiang Guang Ming
b73d35d012 docs: add new mbedtls configuration option in optimize size 2023-08-08 14:03:57 +08:00
Cai Xin Ying
0a726af17b Docs: provide CN translation for three short docs of api-guides 2023-08-04 23:37:26 +08:00
Chen Jian Xing
c4562571e2 Merge branch 'docs/update_multi_antenna_switch_docs' into 'master'
Docs/update multi antenna switch docs

Closes WIFI-5582, WIFI-5561, and DOC-2914

See merge request espressif/esp-idf!22937
2023-08-03 21:27:46 +08:00
Omar Chebib
0368aa5257 Merge branch 'feature/bootloader_ignore_extra_component' into 'master'
bootloader: add the possibility to ignore extra components

Closes IDF-7825

See merge request espressif/esp-idf!24806
2023-08-02 10:28:41 +08:00
Alexey Lapshin
a120ea823e Merge branch 'contrib/github_pr_11569' into 'master'
[GDBStub] kconfig gdbstub runtime should be separate bool (GitHub PR)

Closes IDF-7846 and IDFGH-10309

See merge request espressif/esp-idf!24775
2023-08-02 07:50:47 +08:00
Sergei Silnov
b85093454d Merge branch 'docs/update_information_about_CLI_commands' into 'master'
Updates documentation for new Component Manager CLI commands in IDF

See merge request espressif/esp-idf!24362
2023-08-01 22:05:15 +08:00
Alexey Lapshin
47e400c296 feature(gdbstub): Move runtime gdbstub out of panic config
Closes https://github.com/espressif/esp-idf/pull/11569
2023-08-01 14:28:07 +04:00
Jim Mussared
c7d5112771 idf-docker-image.rst: Run with current user ID instead of root.
Rather than running the command inside the container as root, which will
mean that any build artifacts created will be owned by root on the host,
run the command as the current user.

This requires setting a temporary home directory as idf.py will try to
access e.g. ~/.cache, so just use /tmp inside the container which is
ephemeral anyway.

This also allows the command to use `git`. without setting the user ID,
`docker run ... git status` will fail with
    fatal: detected dubious ownership in repository at '/project'

Also added the missing explanation for `-w /project`.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2023-08-01 11:27:34 +10:00
Daniel Paul
0e91006749 docs(IDF Component Manager): Updates documentation for new Component Manager CLI commands in IDF 2023-07-31 13:27:44 +02:00
Dai Zi Yan
8b9610b94f Merge branch 'docs/udpate_memory-types' into 'master'
Docs/udpate memory types

Closes DOC-5388 and DOC-5157

See merge request espressif/esp-idf!24392
2023-07-31 10:45:12 +08:00
Ivan Grokhotkov
cfa1896780 Merge branch 'contrib/github_pr_11535' into 'master'
Replace deprecated flushregs alias with full gdb command (GitHub PR)

Closes IDFGH-10272

See merge request espressif/esp-idf!24752
2023-07-28 22:40:22 +08:00
Omar Chebib
c98d1f1619 feat(bootloader): add the possibility to ignore extra components 2023-07-28 15:04:21 +08:00
daiziyan
1037135761 docs: provided translation for storage.rst and system.rst and updated a typo for memory-types.rst 2023-07-27 16:24:29 +08:00
caixinying-git
d47457b29b docs: provide CN translation for api-guides/performance/ram-usage.rst 2023-07-25 19:04:41 +08:00
Cai Xin Ying
fcaaf885ab Merge branch 'docs/add_Chinese_translation_for_api-guides_hardware-abstraction.rst' into 'master'
docs: provide CN tranlsation for api-guides/hardware-abstraction.rst

Closes DOC-5451

See merge request espressif/esp-idf!24147
2023-07-24 10:02:11 +08:00
Cai Xin Ying
e9ba6b611e Merge branch 'docs/add_Chinese_translation_for_api-guides/host-apps.rst' into 'master'
docs: provide CN translation for api-guides/host-apps.rst

Closes DOC-5461

See merge request espressif/esp-idf!24260
2023-07-24 10:01:35 +08:00
Cai Xin Ying
9667318a67 docs: provide CN translation for api-guides/openthread.rst 2023-07-21 18:45:58 +08:00
caixinying-git
6f9dad8100 docs: provide CN translation for api-guides/host-apps.rst 2023-07-21 16:38:44 +08:00
caixinying-git
fa7a6a6636 docs: provide CN tranlsation for api-guides/hardware-abstraction.rst 2023-07-21 16:33:36 +08:00
Krzysztof Budzynski
82a0437671 Apply 1 suggestion(s) to 1 file(s) 2023-07-20 15:15:37 +08:00
Wang Tao
0ac1ee4358 Merge branch 'contrib/github_pr_9694' into 'master'
add low power doc and picture (GitHub PR)

Closes IDFGH-8201

See merge request espressif/esp-idf!20675
2023-07-19 17:54:29 +08:00
Roland Dobai
30672c7c65 Merge branch 'docs/monitor_rom_address_decoding' into 'master'
esp_idf_monitor: ROM ELF address decoding docs and tests

Closes IDF-372

See merge request espressif/esp-idf!24271
2023-07-17 18:52:29 +08:00
Marius Vikhammer
f2485590c2 Apply 1 suggestion(s) to 1 file(s) 2023-07-17 16:28:50 +08:00
Daniel Mangum
647e7a2a71
fix: Replace deprecated flushregs alias with full gdb command
Usage of `flushregs` in gdb will result in the following warning:

```
Warning: 'flushregs', an alias for the command 'maintenance flush register-cache', is deprecated.
Use 'maintenance flush register-cache'.
```

This patch updates to use the recommend command.

Signed-off-by: Daniel Mangum <georgedanielmangum@gmail.com>
Merges https://github.com/espressif/esp-idf/pull/11535
2023-07-13 09:26:47 +02:00
zhangwenxu
d29f31ec16 docs(openthread): update openthread README for H2 and C6 2023-07-12 15:57:25 +08:00
muhaidong
49bb7bb35e esp_wifi: update multi antenna switch docs 2023-07-12 12:54:02 +08:00
wang tao
366ae76812 add low power doc and picture
Merges https://github.com/espressif/esp-idf/pull/9694
2023-07-06 11:57:38 +00:00
Jiang Jiang Jian
781d2717cd Merge branch 'bugfix/nan_sd_dp_fixes' into 'master'
NAN Service discovery and datapath bugfixes

Closes WIFI-5588

See merge request espressif/esp-idf!24302
2023-07-06 10:30:05 +08:00
caixinying-git
caf3f6b5fb docs: provide CN translation for api-guides/tools/idf-docker-image.rst 2023-07-05 16:39:14 +08:00
Shyamal Khachane
6138ec7a61 fix(esp_wifi): NAN Service discovery and datapath bugfixes
1. Increase timeout value for NDP Accepted/Rejected events.
    2. Update publisher ID incase publisher restarts(service).
    3. Ignore service discovery frames with invalid/inactive service ID.
    4. Update NAN documentation
2023-07-05 10:35:14 +05:30
Krzysztof Budzynski
b10e69985f Merge branch 'contrib/github_pr_11743' into 'master'
docs(jtag): Update chip revisions to follow ESP32-C3 errata (GitHub PR)

Closes IDFGH-10497

See merge request espressif/esp-idf!24467
2023-07-04 19:20:42 +08:00
Alexey Lapshin
4df3ff619e feat(esp_system): implement hw stack guard for riscv chips
- add hardware stack guard based on assist-debug module
- enable hardware stack guard by default
- disable hardware stack guard for freertos ci.release test
- refactor rtos_int_enter/rtos_int_exit to change SP register inside them
- fix panic_reason.h header for RISC-V
- update docs to include information about the new feature
2023-07-01 16:27:40 +00:00
Xabi Crespo
9cab62e734 docs(jtag): Update chip revisions to follow ESP32-C3 errata (GitHub PR) 2023-06-29 12:55:05 +08:00
daiziyan
573fadd5be docs:provide CN translation for idf-monitor 2023-06-28 15:42:05 +02:00
Mahavir Jain
08be8ff5ec Merge branch 'support/esp_coredump_logs_config' into 'master'
Optionally disable logs in espcoredump component

See merge request espressif/esp-idf!23899
2023-06-28 20:28:40 +08:00
Cai Xin Ying
29f3221b56 Merge branch 'docs/add_Chinese_translation_for_linux-host-requirements.rst_and_external-ram-esp32-notes.rst' into 'master'
docs: provide CN translation for linux-host-requirements.rst and external-ram-esp32-notes.rst

Closes DOC-5412

See merge request espressif/esp-idf!24115
2023-06-28 20:03:49 +08:00
caixinying-git
a33b276671 docs: provide CN translation for linux-host-requirements.rst and external-ram-esp32-notes.rst 2023-06-28 16:42:17 +08:00
Vikram
e3584c5dd0 Added description to disable coredump logs to ram_usage.rst
Signed-off-by: Vikram <vikram.dattu@espressif.com>
2023-06-28 06:46:32 +00:00
Liu Ning
8514469092 esp_wifi: fix ret when setting channel at wifi not started, fix timer callback 2023-06-27 21:34:53 +08:00
Darian Leung
1ebec10d48 wifi: Fix typos and formatting issues with wifi.rst
- Used code-blocks for correct highlighting
- Use inline literals for macros
- Fixed some typos
2023-06-26 16:29:09 +08:00
Wang Kai
25537c6c02 Wifi: Fixed typo in wifi.rst
Closes https://github.com/espressif/esp-idf/pull/11640

[darian@espressif.com: Updated commit message]
Signed-off-by: Darian Leung <darian@espressif.com>
2023-06-26 14:58:37 +08:00
Mahavir Jain
62634fcced Merge branch 'feature/add_documentation_for_external_flash_encryption' into 'master'
flash_encryption_docs: Add documentation regarding enabling flash encryption externally through espefuse tool

Closes IDF-7107

See merge request espressif/esp-idf!23220
2023-06-23 12:36:12 +08:00
radim.karnis
4f4c91cee3 docs(esp_idf_monitor): ROM ELF address decoding 2023-06-21 11:08:09 +02:00
Mo Fei Fei
85970f8cf7 Docs: update CN translation for external-ram.rst 2023-06-20 10:45:23 +08:00
Zhang Xiao Yan
4a545a5a0f Merge branch 'docs/format_ap_basic_configuration_tables' into 'master'
docs: format AP basic configuration tables in wifi.rst

See merge request espressif/esp-idf!23945
2023-06-19 10:27:19 +08:00
Aditya Patwardhan
253d80f560 docs/security: Move security related docs in a separate section 2023-06-17 10:04:01 +05:30
Aditya Patwardhan
6d4a116625 docs: Added documentation about enabling the Security Features
externally with help of espefuse tool

flash_encryption_doc: Fix the document to also inform users about what
happens in case of host generated private key in the Flash encryption process
2023-06-17 10:04:01 +05:30
Li Xiao Yi
2dc7f62974 Merge branch 'docs/add_speed_CN_trans' into 'master'
Docs: add translation for api-guides/performance/speed.rst

Closes DOC-5229

See merge request espressif/esp-idf!23868
2023-06-16 17:09:23 +08:00
Li Xiaoyi
a9d0825b1b Docs: add CN translation for api-guides/performance/speed.rst 2023-06-16 15:18:29 +08:00
Armando
9c1b38d061 psram: remove reference to spi ram, use PSRAM instead as the reference to the physical memory 2023-06-14 19:43:56 +08:00
Armando
043a8f93f7 psram: fixed wrong virtual address for PSRAM in external-ram.rst 2023-06-14 19:29:12 +08:00
Radim Karniš
c18cdd8859 Merge branch 'docs/uf2' into 'master'
docs: Add idf.py uf2 command description

Closes IDF-2589

See merge request espressif/esp-idf!24010
2023-06-12 18:41:17 +08:00
Li Xiao Yi
38d679c0bd Merge branch 'docs/translate_api-guides_performance' into 'master'
docs: add translation for docs/zh_CN/api-guides/performance/size.rst

Closes DOC-5208

See merge request espressif/esp-idf!23773
2023-06-12 12:44:19 +08:00
Doc-intern2
c166bcd6c6 Docs: add translation for api-guides/performance/size.rst 2023-06-12 10:55:37 +08:00
Mo Fei Fei
c78436e796 Docs: Update CN translation for idf-py.rst 2023-06-09 15:53:28 +08:00
Linda
29f68ae5aa docs: format AP basic configuration tables in wifi.rst 2023-06-09 15:04:47 +08:00
Cai Xin Ying
d25b5e45aa Merge branch 'docs/add_Chinese_translation_for_api-guides/tools/idf-tools.rst' into 'master'
docs: provide CN translation for api-guides/tools/idf-tools.rst

Closes DOC-5217

See merge request espressif/esp-idf!23774
2023-06-08 12:55:42 +08:00
caixinying-git
ec1e03e132 docs: provide CN translation for api-guides/tools/idf-tools.rst 2023-06-08 11:44:07 +08:00
Zhang Xiao Yan
60441881a5 Merge branch 'docs/add_power_measure_module_deep_sleep_mode' into 'master'
docs: add a chapter to describe how to measure current of modules in deep sleep mode

Closes DOC-517

See merge request espressif/esp-idf!21438
2023-06-06 18:29:41 +08:00
Fu Hanxi
22a8784553 docs: fix 404 links 2023-06-06 11:11:23 +08:00
radim.karnis
066a269fbf docs: Add idf.py uf2 command description 2023-06-01 15:25:06 +02:00