Merge branch 'bugfix/docs_small_corrections' into 'master'

igrr · igrr · commit 7a1e3265fe6e · 2018-03-13T17:43:00.000+08:00
Bugfix/docs small corrections

See merge request idf/esp-idf!2025
diff --git a/components/spi_flash/README.rst b/components/spi_flash/README.rst
@@ -121,7 +121,7 @@ and perform operations on them. These functions are declared in ``esp_partition.
 - :cpp:func:`esp_partition_next` advances iterator to the next partition found
 - :cpp:func:`esp_partition_iterator_release` releases iterator returned by ``esp_partition_find``
 - :cpp:func:`esp_partition_find_first` is a convenience function which returns structure
-  describing the first partition found by esp_partition_find
+  describing the first partition found by ``esp_partition_find``
 - :cpp:func:`esp_partition_read`, :cpp:func:`esp_partition_write`, :cpp:func:`esp_partition_erase_range`
   are equivalent to :cpp:func:`spi_flash_read`, :cpp:func:`spi_flash_write`,
   :cpp:func:`spi_flash_erase_range`, but operate within partition boundaries
diff --git a/docs/api-reference/storage/spi_flash.rst b/docs/api-reference/storage/spi_flash.rst
@@ -40,7 +40,7 @@ CPU A as well and returns control to the calling code.
 
 Additionally, all API functions are protected with a mutex (s_flash_op_mutex).
 
-In a single core environment (CONFIG_FREERTOS_UNICORE enabled), we simply
+In a single core environment (:ref:`CONFIG_FREERTOS_UNICORE` enabled), we simply
 disable both caches, no inter-CPU communication takes place.
 
 API Reference - SPI Flash
diff --git a/docs/api-reference/storage/wear-levelling.rst b/docs/api-reference/storage/wear-levelling.rst
@@ -3,7 +3,7 @@
 See also
 --------
 
-- :doc:`FAT Filesystem <../../api-guides/partition-tables>`
+- :doc:`FAT Filesystem <./fatfs>`
 - :doc:`Partition Table documentation <../../api-guides/partition-tables>`
 
 Application Example
diff --git a/docs/get-started/get-started-wrover-kit.rst b/docs/get-started/get-started-wrover-kit.rst
@@ -225,7 +225,9 @@ SPI Flash / JP13
 | 6 | CMD / GPIO11 |
 +---+--------------+
 
-The module's flash bus is connected to the pin header JP13 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz, to improve integrity of the bus signals, it is recommended to desolder resistors R140 ~ R145. At this point, the module's flash bus is disconnected with the pin header JP13.
+.. important::
+
+    The module's flash bus is connected to the pin header JP13 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz, to improve integrity of the bus signals, it is recommended to desolder resistors R140 ~ R145. At this point, the module's flash bus is disconnected with the pin header JP13.
 
 
 .. _get-started-esp-wrover-jtag-header:
diff --git a/docs/resources.rst b/docs/resources.rst
@@ -6,10 +6,14 @@ Resources
 
 * Check the `Issues <https://github.com/espressif/esp-idf/issues>`_  section on GitHub if you find a bug or have a feature request. Please check existing `Issues <https://github.com/espressif/esp-idf/issues>`_ before opening a new one.
 
-* If you're interested in contributing to ESP-IDF, please check the :doc:`contribute/index`.
+* A comprehensive collection of `solutions <https://github.com/espressif/esp-iot-solution#solutions>`_, `practical applications <https://github.com/espressif/esp-iot-solution#esp32-iot-example-list>`_, `components and drivers <https://github.com/espressif/esp-iot-solution#components>`_ based on ESP-IDF is avialable in `ESP32 IoT Solution <https://github.com/espressif/esp-iot-solution>`_ repository. In most of cases descriptions are provided both in English and in 中文. 
 
 * To develop applications using Arduino platform, refer to `Arduino core for ESP32 WiFi chip <https://github.com/espressif/arduino-esp32#arduino-core-for-esp32-wifi-chip>`_.
 
-* For additional ESP32 product related information, please refer to `documentation <https://espressif.com/en/support/download/documents>`_ section of `Espressif <https://espressif.com/>`_ site.
+* Several `books <https://www.espressif.com/en/support/iot-college/books-new>`_ have been written about ESP32 and they are listed on `Espressif <https://www.espressif.com/en/support/iot-college/books-new>`__ web site.
+
+* If you're interested in contributing to ESP-IDF, please check the :doc:`contribute/index`.
+
+* For additional ESP32 product related information, please refer to `documentation <https://espressif.com/en/support/download/documents>`_ section of `Espressif <https://espressif.com/en/support/download/documents>`__ site.
 
-* Mirror of this documentation is available under: https://dl.espressif.com/doc/esp-idf/latest/.
+* Mirror of this documentation is available under: https://espressif-docs.readthedocs-hosted.com/projects/esp-idf/en/latest/ and https://dl.espressif.com/doc/esp-idf/latest/.
diff --git a/examples/peripherals/spi_master/README.md b/examples/peripherals/spi_master/README.md
@@ -0,0 +1,5 @@
+## SPI master example
+
+This code displays a simple graphics with varying pixel colors on the 320x240 LCD on an ESP-WROVER-KIT board.
+
+If you like to adopt this example to another type of display or pinout, check [manin/spi_master_example_main.c] for comments that explain some of implementation details.
diff --git a/examples/peripherals/spi_slave/README.md b/examples/peripherals/spi_slave/README.md
@@ -1,22 +1,15 @@
 ## SPI slave example
 
-These two projects illustrate the SPI Slave driver. They're supposed to be flashed into two separate ESP32s connected to
-eachother using the SPI pins defined in app_main.c. Once connected and flashed, they will use the spi master and spi slave
-driver to communicate with eachother. The example also includes a handshaking line to allow the master to only poll the 
-slave when it is actually ready to parse a transaction.
+These two projects illustrate the SPI Slave driver. They're supposed to be flashed into two separate ESP32s connected to eachother using the SPI pins defined in app_main.c. Once connected and flashed, they will use the spi master and spi slave driver to communicate with eachother. The example also includes a handshaking line to allow the master to only poll the  slave when it is actually ready to parse a transaction.
 
 Please run wires between the following GPIOs between the slave and master to make the example function:
 
-========= ====== =======
-Signal    Slave  Master
-========= ====== =======
-Handshake GPIO2  GPIO2
-MOSI      GPIO12 GPIO12
-MISO      GPIO13 GPIO13
-SCLK      GPIO15 GPIO15
-CS        GPIO14 GPIO14
-========= ====== =======
+| Signal    | Slave  | Master |
+|-----------|--------|--------|
+| Handshake | GPIO2  | GPIO2  |
+| MOSI      | GPIO12 | GPIO12 |
+| MISO      | GPIO13 | GPIO13 |
+| SCLK      | GPIO15 | GPIO15 |
+| CS        | GPIO14 | GPIO14 |
 
-Be aware that the example by default uses lines normally reserved for JTAG. If this is an issue, either because of hardwired
-JTAG hardware or because of the need to do JTAG debugging, feel free to change the GPIO settings by editing defines in the top
-of main.c in the master/slave source code.
+Be aware that the example by default uses lines normally reserved for JTAG. If this is an issue, either because of hardwired JTAG hardware or because of the need to do JTAG debugging, feel free to change the GPIO settings by editing defines in the top of main.c in the master/slave source code.
