Commit Graph

1437 Commits

Author SHA1 Message Date
Dai Zi Yan
e1a6d45e83 Backport CN translation for api-guides for v4.0 2021-04-23 15:52:58 +08:00
Marius Vikhammer
531cab5fc4 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:04 +08:00
Marius Vikhammer
6b251820d7 docs: fix "link to translation" being broken
The translation link would link a specifc commit hash instead of
the release name.
2021-03-22 13:55:21 +08:00
Roland Dobai
b086a41569 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:47:14 +01:00
Marius Vikhammer
8e7e0973db docs: self host docs
Move doc hosting from readthedocs to espressif servers

Update CI, Sphinx configs and add IDF Sphinx theme
2021-02-08 11:54:11 +08:00
Victor Lamoine
cad6eda381 Fix ccache documentation: environment variable is IDF_CCACHE_ENABLE
Merges https://github.com/espressif/esp-idf/pull/5753
2020-12-14 07:26:09 +00:00
Angus Gratton
047480058c 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-12-14 07:26:09 +00:00
daiziyan
4c65e031ea add CN translation for adding python2 deprecation warning(MR 11115) 2020-12-09 23:50:19 +01:00
martin.gano
c05fcc6a1d Tools: add Python 2 deprecation warning 2020-12-08 15:46:41 +01:00
Dai Zi Yan
14de2ba81a update CN translation for index.rst in get-started folder (v4.0) 2020-12-08 10:44:40 +08:00
Darian Leung
7c8208d903 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.
2020-12-04 19:03:19 +08:00
dongyou
2252c75588 esp_wifi: update description for WiFi APIs
1. Add description for esp_wifi_set_inactive_time()
2. Add documentation to avoid using WiFi modem sleep for WiFi/BT coexistence
3. Remove description of unusable API esp_wifi_restart()
4. Update esp_now_fetch_peer discription
5. Update table format prblm for esp_wifi_set_max_tx_power()
6. Update description for ssid and password
2020-12-01 15:48:59 +08:00
Krzysztof Budzynski
9b1f47df1d Merge branch 'bugfix/remove_shortcut_to_build_instructions_v4.0' into 'release/v4.0'
doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions (v4.0)

See merge request espressif/esp-idf!10608
2020-11-11 11:02:15 +08:00
Krzysztof Budzynski
8007eb9a31 Merge branch 'bugfix/doc_main_readme_build_v4.0' into 'release/v4.0'
Fix the setup instructions in the main README (v4.0)

See merge request espressif/esp-idf!10339
2020-11-06 08:32:47 +08:00
Krzysztof Budzynski
a6e65a47a8 Merge branch 'feature/guide_change_for_catalina_v4.0' into 'release/v4.0'
docs: Add profile file name used by zsh shell (v4.0)

See merge request espressif/esp-idf!10774
2020-11-06 08:29:45 +08:00
martin.gano
d7e5094670 docs: add description of python-clean command 2020-10-10 09:56:04 +00:00
Krzysztof
4f00268cfa docs: Add profile file name used by zsh shell 2020-10-09 19:17:15 +02:00
Krzysztof
312504a52f doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions 2020-10-09 02:52:09 +00:00
Angus Gratton
3350a108c3 build system: Also get IDF version from annotated tags only
Builds on previous commit.

Note: Getting the project version still pases --tags so still works with plain
tags, to keep compatibility for existing projects
2020-10-07 13:55:53 +11:00
Roland Dobai
1cc99eefb7 Fix the setup instructions in the main README 2020-09-08 10:18:27 +02:00
Michael (XIAO Xufeng)
d1fa5c712a Merge branch 'bugfix/freemodbus_fix_long_frame_buffer_failure_backport4_0' into 'release/v4.0'
freemodbus: freemodbus fix long frame buffer failure (backport v4.0)

See merge request espressif/esp-idf!8199
2020-09-02 16:12:28 +08:00
yiying
9c82e7c875 docs: add a note about ESP-IDF FreeRTOS version 2020-07-27 20:24:43 +08:00
yiying
61bc60213e docs: change redirection link in get-started
This link is supposed to go to Step 3, but it goes to Step 2.
2020-07-22 17:17:38 +08:00
Ivan Grokhotkov
1e95aba03a Merge branch 'feature/msys2_env_update_v4.0' into 'release/v4.0'
windows: Update MSYS2 pre-compiled legacy build environment (v4.0)

See merge request espressif/esp-idf!9144
2020-07-06 15:16:39 +08:00
Nachiket Kukade
2c45d430da esp_wifi: Update wifi lib
1. Avoid parsing RSN/WPA IE's after connection
2. Remove AUTH_CHANGED reason code logic
2020-07-01 16:24:23 +05:30
Krzysztof Budzynski
e9dcba0d5d Merge branch 'docs/spi' into 'release/v4.0'
Fixed a typo according to DOC-216

See merge request espressif/esp-idf!9133
2020-06-28 18:22:29 +08:00
Wang Ning
1658838efb Fixed a typo according to DOC-216 2020-06-28 18:22:29 +08:00
morris
b53c59b7a4 tools: fix python lint 2020-06-24 13:22:21 +08:00
Krzysztof Budzynski
4f29dfa969 Merge branch 'bugfix/doc_build_ut_cmdline_v4.0' into 'release/v4.0'
docs: Fixup format of a command line to build unit tests (backport v4.0)

See merge request espressif/esp-idf!9044
2020-06-15 02:43:02 +08:00
Angus Gratton
a972d3018c windows: Update MSYS2 pre-compiled legacy build environment
* Bundled with esp2020r2 toolchain
* Built with Python 3 & latest MSYS2 packages
2020-06-12 10:24:29 +10:00
aleks
6932b4d1c0 freemodbus: add comments for limitation in current version of freemodbus 2020-06-08 08:39:49 +02:00
kapil.gupta
d008eba708 esp_wifi: Remove auth_changed event and fix wpa2 authmode threshold
Added following as part of this change
1. Removed auth_changed event
2. Updated doc regarding usage of  WPA/WEP secuiry modes
3. Fixed WPA2 enterprise authmode threshold.
2020-06-07 10:55:02 +05:30
Anton Maklakov
7d6bcf5f5e docs: Fixup format of a command line to build unit tests 2020-06-03 12:17:36 +07:00
Angus Gratton
90f6c9652e Merge branch 'doc/openocd_security_features_v4.0' into 'release/v4.0'
doc: Add caveats about using JTAG debugging with hardware security features (v4.0)

See merge request espressif/esp-idf!8464
2020-05-27 07:49:44 +08:00
lly
bcc1eb916b ble_mesh: Rename the folders ble_mesh_fast_prov_* to fast_prov_* 2020-05-22 14:28:38 +08:00
lly
cdd35648b7 ble_mesh: Doc miscellaneous fixes
- Update ble mesh architecture
2020-05-21 17:48:21 +08:00
Angus Gratton
6153026f22 doc: Fix broken Release page links when building a stable version 2020-05-20 11:32:53 +10:00
Angus Gratton
b0f053d82d Merge branch 'bugfix/get_started_export_profile_v4.0' into 'release/v4.0'
docs: remove suggestion about running export.sh from .profile script (backport v4.0)

See merge request espressif/esp-idf!8614
2020-05-07 12:07:05 +08:00
Sagar Bijwe
6d6b7b09e8 wifi: Add PMF and WPA3 documentation 2020-05-06 10:20:40 +05:30
Ivan Grokhotkov
7fbfb1aa03 docs: remove suggestion about running export.sh from .profile script
This was quite obviously a bad suggestion, and it seems that some
users have actually read the docs attentively enough to have followed
it. Replace be recommendation to create an alias.

Closes https://github.com/espressif/esp-idf/issues/3889
2020-05-05 21:39:30 +02:00
lly
9370264cac doc: Fix some ble mesh description 2020-04-27 15:25:46 +08:00
Angus Gratton
07c1d9d9c7 doc: Add warnings about using JTAG debugging with hardware security features
This is related to the following issues but is not a fix, just documentation of a workaround until we can
improve the support:
https://github.com/espressif/esp-idf/issues/4878
https://github.com/espressif/esp-idf/issues/4734
2020-04-27 16:41:16 +10:00
liying
4131b51c16 Backport changes made in 6147 to release/4.0 2020-04-20 21:47:26 +08:00
Angus Gratton
fd58809899 Merge branch 'bugfix/esp_event_bugfixes_v4.0' into 'release/v4.0'
esp_event-related fixes (v4.0)

See merge request espressif/esp-idf!8072
2020-04-09 22:11:16 +08:00
Roland Dobai
13f4656d2a tools: Fix flashing encrypted binaries from IDF Monitor 2020-03-27 10:31:37 +01:00
Rusty Eddy
cb871f0472 Added semi-colon to esp_event_loop_create(...)
Title sums it up.
2020-03-22 21:45:26 +08:00
Renz Christian Bagaporo
0f036b8749 ulp: use quotes when specifying files for embedding ulp binaries 2020-03-22 21:07:58 +08:00
Angus Gratton
376703bf05 Merge branch 'bugfix/cmake_convert_whitespace_v4.0' into 'release/v4.0'
cmake: Minor convert_to_cmake.py fixes (v4.0)

See merge request espressif/esp-idf!7876
2020-03-09 06:55:19 +08:00
Krzysztof Budzynski
af5adbc18e Correct ULP REG_WR and REG_RD instruction for ESP32 2020-03-06 19:09:43 +08:00
Angus Gratton
3d0ecfdc70 cmake: Add warnings that convert_to_cmake.py doesn't calculate component requirements
Any component which requires another component will need this manually
added to its CMakeLists.txt file.
2020-03-05 17:06:38 +11:00