alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 10:46:02 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
5a88f90a33
esp-idf/docs
History
Ivan Grokhotkov 5a88f90a33 soc/rtc: warn if detected XTAL frequency does not match configured one 
Since 9a8c0392, XTAL frequency is set to 40MHz by default, and users
of 26MHz boards need to select 26MHz manually. Most users are not aware
of this change, and existing getting started guides do not mention that
XTAL frequency needs to be set for some boards. So users are left with
garbage output from UART without any clue what to check.

This change adds a warning in case specific XTAL frequency was set, and
it does not match automatically detected one. This should help users
fix the issue.
2017-09-11 11:42:26 +08:00
..
_static Implemented 2 of 3 review comments 2017-09-05 08:28:44 +02:00
api-guides Fixed broken links in documentation 2017-09-07 18:48:15 +02:00
api-reference Merge branch 'feature/docs_touch_pad_api' into 'master' 2017-09-08 11:55:27 +08:00
contribute Mass replacement of http with https urls, fixed broken urls 2017-09-06 08:16:01 +02:00
get-started soc/rtc: warn if detected XTAL frequency does not match configured one 2017-09-11 11:42:26 +08:00
hw-reference Mass replacement of http with https urls, fixed broken urls 2017-09-06 08:16:01 +02:00
security docs: fix flash encryption key storage block, use same names as in TRM 2017-07-06 10:47:18 +08:00
about.rst Getting started guides 2017-04-27 19:51:42 +02:00
conf.py docs: generate documentation for Kconfig options 2017-08-22 15:12:34 +08:00
COPYRIGHT.rst Mass replacement of http with https urls, fixed broken urls 2017-09-06 08:16:01 +02:00
Doxyfile doc: Add docs for heap trace & poisoning 2017-09-07 16:32:05 +10:00
gen-dxd.py docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00
gen-kconfig-doc.py docs: generate documentation for Kconfig options 2017-08-22 15:12:34 +08:00
index.rst Getting started guides 2017-04-27 19:51:42 +02:00
kconfiglib.py docs: generate documentation for Kconfig options 2017-08-22 15:12:34 +08:00
link-roles.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
Makefile docs: Generate Doxygen directives for API documentation 2017-05-19 18:26:02 +02:00
README.md Mass replacement of http with https urls, fixed broken urls 2017-09-06 08:16:01 +02:00
repo_util.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
requirements.txt docs: Included information about ESP32-WROVER module 2017-08-22 20:08:04 +02:00
resources.rst Mass replacement of http with https urls, fixed broken urls 2017-09-06 08:16:01 +02:00

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated instantly on each commit: