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
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
97b6b435a8
docs: Remove some uses of IDF_TARGET_NAME accidentally backported
2021-05-31 11:09:05 +10:00
daiziyan
c8906224fd
add CN translation for index.rst in get started section for MR10616
2021-05-31 11:08:00 +10: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
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
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
Marius Vikhammer
329ae0a987
docs: self host docs
...
Move doc hosting from readthedocs to espressif servers
Update CI, Sphinx configs and add IDF Sphinx theme
2020-11-24 02:16:02 +00: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
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
Lu Chang Jie
3512a775bc
Test:merge ble mesh node and provioner in console
2020-08-21 20:00:32 +08:00
yiying
ca38f1eb0a
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:44:06 +08:00
Angus Gratton
f5a7c9635f
Merge branch 'feature/msys2_env_update_v4.1' into 'release/v4.1'
...
windows: Update MSYS2 pre-compiled legacy build environment (v4.1)
See merge request espressif/esp-idf!9143
2020-07-08 17:34:33 +08:00
morris
4daa605bd3
gh_action: fix python lint
2020-06-24 13:17:29 +08:00
Angus Gratton
194a3b09dc
windows: Update MSYS2 pre-compiled legacy build environment
...
* Bundled with esp2020r2 toolchain
* Built with Python 3 & latest MSYS2 packages
2020-06-12 10:22:10 +10:00
Marius Vikhammer
7d3d56ff9a
doc: add peripheral_types.h as API reference for peripheral docs
...
Closes DOC-136
Closes IDF-1673
2020-05-27 12:38:38 +08:00
Island
3cfd7eebd1
Merge branch 'example/ble_mesh_structural_adjust_v4.1' into 'release/v4.1'
...
Example/ble mesh structural adjust (v4.1)
See merge request espressif/esp-idf!8856
2020-05-22 19:15:57 +08:00
lly
b4588f7d92
ble_mesh: Rename the folders ble_mesh_fast_prov_* to fast_prov_*
2020-05-22 05:43:57 +00:00
Angus Gratton
4a42368603
doc: Fix broken Release page links when building a stable version
2020-05-20 11:30:17 +10:00
Island
fefa9b7fe9
Merge branch 'doc/ble_mesh_fixes_v4.1' into 'release/v4.1'
...
doc: Fix some ble mesh description (v4.1)
See merge request espressif/esp-idf!8502
2020-05-06 11:13:16 +08:00
lly
c28828d255
doc: Fix some ble mesh description
2020-04-30 11:43:26 +00:00
Angus Gratton
2fb9cad1b4
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:40:06 +10:00
Renz Christian Bagaporo
1717232f11
ulp: use quotes when specifying files for embedding ulp binaries
2020-03-22 19:59:50 +08:00
Supreet Deshpande
27e9cb785a
feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3
2020-03-06 01:16:04 +05:30
lly
711c8472fc
ble_mesh: Miscellaneous modifications
...
1. Add an API to set Provisioner static oob value
2. Add an API to deinit BLE Mesh stack
3. Add an API to set Provisioner unicast address
4. Add an API to provision devices with fixed address
5. Add an API to store node composition data
6. Add an API to get node with device uuid
7. Add an API to get node with unicast address
8. Add an API to delete node with device uuid
9. Add an API to delete node with unicast address
10. Add an API for Provisioner to update local AppKey
11. Add an API for Provisioner to update local NetKey
12. Support Provisioner persistent functionality
13. Fix Provisioner entering IV Update procedure
14. Fix an issue which may cause client failing to send msg
15. Use bt_mesh.flags to indicate device role
16. Remove several useless macros
17. Callback RSSI of received mesh provisioning packets
18. Modify the Provisioner disable function
19. Change some log level from debug to info
20. Add parameters to Provisioner bind AppKey completion event
21. Fix node ignoring relay messages issue
22. Support using a specific partition for BLE Mesh
23. Fix compile warning when proxy related macros are disabled
24. Clean up BLE Mesh stack included header files
25. NULL can be input if client message needs no parameters
26. Fix compile warning when BT log is disabled
27. Initilize BLE Mesh stack local variables
28. Support using PSRAM for BLE Mesh mutex, queue and task
29. Add a menuconfig option to enable using memory from PSRAM
30. Clean up sdkconfig.defaults of BLE Mesh examples
2020-03-02 02:08:13 +00:00
Krzysztof
f4f2724a4e
Include feedback link in footer
2020-02-29 00:32:35 +08:00
Roland Dobai
de3eed647f
Docs: Encourage to used Python 3
2020-02-26 09:11:13 +01:00
Ivan Grokhotkov
4541e065e4
docs: update version of IDF tools installer for windows to v2.3
2020-02-12 10:26:34 +11:00
Krzysztof Budzynski
5aa21584cf
Merge branch 'doc/ulp_cmake_fix' into 'master'
...
doc: Remove duplicate ulp-cmake
See merge request espressif/esp-idf!7259
2020-01-10 15:29:56 +08:00
Angus Gratton
13f67d4279
doc: Remove duplicate ulp-cmake
...
This file was renamed in 62ed221
when CMake became default, but 8fe3ecd
accidentally reintroduced it.
A redirect is still generated from ulp-cmake to ulp, so the old URL continues to work.
2020-01-10 16:38:06 +11:00