Merge branch 'bugfix/doc_bugfixes' into 'master'

Corrected small issues in documentation, fixes #694 and merges #706

See merge request !894
This commit is contained in:
Ivan Grokhotkov 2017-06-20 17:25:03 +08:00
commit 89d503edf0
3 changed files with 6 additions and 6 deletions

View file

@ -52,7 +52,7 @@ You don't need to run `make all` before running `make flash`, `make flash` will
## Viewing Serial Output ## Viewing Serial Output
The `make monitor` target uses the [idf_monitor tool](http://esp-idf.readthedocs.io/en/latest/idf-monitor.html) to display serial output from the ESP32. idf_monitor also has a range of features to decode crash output and interact with the device. [Check the documentation page for details](http://esp-idf.readthedocs.io/en/latest/idf-monitor.html). The `make monitor` target uses the [idf_monitor tool](http://esp-idf.readthedocs.io/en/latest/get-started/idf-monitor.html) to display serial output from the ESP32. idf_monitor also has a range of features to decode crash output and interact with the device. [Check the documentation page for details](http://esp-idf.readthedocs.io/en/latest/get-started/idf-monitor.html).
Exit the monitor by typing Ctrl-]. Exit the monitor by typing Ctrl-].
@ -112,5 +112,5 @@ This can be combined with other targets, ie `make erase_flash flash` will erase
* [Check the Issues section on github](https://github.com/espressif/esp-idf/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one. * [Check the Issues section on github](https://github.com/espressif/esp-idf/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one.
* If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](http://esp-idf.readthedocs.io/en/latest/contributing.html>). * If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](http://esp-idf.readthedocs.io/en/latest/contribute/index.html).

View file

@ -130,10 +130,10 @@ typedef enum {
GPIO_NUM_0 = 0, /*!< GPIO0, input and output */ GPIO_NUM_0 = 0, /*!< GPIO0, input and output */
GPIO_NUM_1 = 1, /*!< GPIO1, input and output */ GPIO_NUM_1 = 1, /*!< GPIO1, input and output */
GPIO_NUM_2 = 2, /*!< GPIO2, input and output GPIO_NUM_2 = 2, /*!< GPIO2, input and output
@note There are more enumerations like that @note There are more enumerations like that
up to GPIO39, excluding GPIO20, GPIO24 and GPIO28..31. up to GPIO39, excluding GPIO20, GPIO24 and GPIO28..31.
They are not shown here to reduce redundant information. They are not shown here to reduce redundant information.
@note GPIO34..29 are input mode only. */ @note GPIO34..39 are input mode only. */
/** @cond */ /** @cond */
GPIO_NUM_3 = 3, /*!< GPIO3, input and output */ GPIO_NUM_3 = 3, /*!< GPIO3, input and output */
GPIO_NUM_4 = 4, /*!< GPIO4, input and output */ GPIO_NUM_4 = 4, /*!< GPIO4, input and output */

View file

@ -86,6 +86,6 @@ V2 boards have a shiny black finish and a male camera header, while V3 boards ha
* `FTDI Virtual COM Port Drivers`_ * `FTDI Virtual COM Port Drivers`_
.. _JTAG Debugging for ESP32: https://github.com/espressif/esp-idf/ .. _JTAG Debugging for ESP32: http://espressif.com/sites/default/files/documentation/jtag_debugging_for_esp32_en.pdf
.. _FTDI Virtual COM Port Drivers: http://www.ftdichip.com/Drivers/D2XX.htm .. _FTDI Virtual COM Port Drivers: http://www.ftdichip.com/Drivers/D2XX.htm