alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
6181c39f05
esp-idf/docs
History
Angus Gratton 02fdf8271d Merge branch 'feature/idf_monitor' into 'master' 
Expand  'make monitor' support

New 'make monitor' idf_monitor tool for better monitor output. Running 'make monitor' will now:
* Automatically look up code addresses via addr2line and print function, source file, line number in terminal.
* Can reset the ESP32 by typing Ctrl-T Ctrl-R.
* Can run "make flash" by typing Ctrl-T Ctrl-F.
* Can run "make app-flash" by typing Ctrl-T Ctrl-A.
* If gdb stub starts, monitor will automatically run gdb and connect. When gdb exits, ESP32 resets and monitor resumes.
* Exit is still Ctrl-[

Have some more features I'd like to add (log output to file, crash dump support) but I think this is at the point of being useful.


See merge request !565
2017-03-15 10:41:08 +08:00
..
_static doc: Documenting Code clean up 2016-11-21 10:24:12 +08:00
api deep sleep: add notice that pads used for wakeup will be configured as RTC GPIOs 2017-03-09 10:21:31 +11:00
security flash encryption/secure boot: Restructure documentation 2017-02-15 09:42:46 +11:00
build-system.rst docs: Fix typo in build-system.rst 2017-03-03 14:59:15 +11:00
conf.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
contributing.rst Link to file a folder up 2016-11-01 01:20:04 +08:00
contributor-agreement.rst docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
COPYRIGHT.rst Add jsmn JSON parser component 2017-03-07 10:18:47 +11:00
core_dump.rst esp32: Fixed and updated core dump docs 2017-01-26 18:47:10 +03:00
deep-sleep-stub.rst Fixed section header style 2016-11-05 17:06:55 +01:00
documenting-code.rst docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
Doxyfile flash encryption/secure boot: Restructure documentation 2017-02-15 09:42:46 +11:00
doxygen_xml_to_rst.xslt rmt: add documentation 2016-11-22 01:44:23 +08:00
eclipse-setup-windows.rst Build system: Add new BATCH_BUILD flag to disable interactive parts of the build 2017-02-22 11:59:37 +11:00
eclipse-setup.rst docs/eclipse: Add considerations for PATH, PYTHONPATH 2017-03-03 15:33:23 +11:00
esp32.cfg Fix issued raised in the merge request 2016-08-30 11:30:03 +08:00
general-notes.rst docs: Improve/clarify partition, OTA & SPI flash docs 2017-02-20 15:31:42 +11:00
idf-monitor.rst tools: New idf_monitor 'make monitor' tool for smarter monitor output 2017-03-13 09:31:45 +08:00
index.rst tools: New idf_monitor 'make monitor' tool for smarter monitor output 2017-03-13 09:31:45 +08:00
link-roles.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
linux-setup.rst docs/*-setup: Use --enable-local instead of --prefix=$PWD for ct-ng 2017-03-03 14:59:15 +11:00
macos-setup.rst docs/*-setup: Use --enable-local instead of --prefix=$PWD for ct-ng 2017-03-03 14:59:15 +11:00
make-project.rst docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
Makefile docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
openocd.rst Simplified "Installing OpenOCD" with git clone --recursive 2016-11-17 10:19:42 +11:00
partition-tables.rst docs: Improve/clarify partition, OTA & SPI flash docs 2017-02-20 15:31:42 +11:00
README.md Docs folder info, ref. https://github.com/espressif/esp-idf/issues/243; Doc title fix 2017-01-17 20:37:27 +01:00
repo_util.py docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08:00
requirements.txt docs: fix typos, build docs with gitlab CI 2016-11-01 20:08:29 +08:00
style-guide.rst Fixed link so it can render by Sphinx 2016-11-10 22:44:59 +01:00
ulp.rst Updated relative paths to included documents 2017-01-16 23:08:35 +01:00
unit-tests.rst esp32: add unit testing doc 2017-01-18 17:08:20 +08:00
windows-setup.rst docs: use custom roles to generate GitHub links 2017-01-20 17:22:47 +08: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: