Typo corrections

diff --git a/docs/api/wifi/esp_smartconfig.rst b/docs/api/wifi/esp_smartconfig.rst
index 262218aa8b2853bca3cd18b0856e945ac200e701..11a6bccbfa37b795bfb6c631a9752d6511e0afe9 100644 (file)
--- a/docs/api/wifi/esp_smartconfig.rst
+++ b/docs/api/wifi/esp_smartconfig.rst
@@ -1,5 +1,5 @@
 Smart Config
-===
+============
 
 API Reference
 -------------

diff --git a/docs/build_system.rst b/docs/build-system.rst
similarity index 98%
rename from docs/build_system.rst
rename to docs/build-system.rst
index d4353287b941bd723aa399f7bbfafcd3ed336533..8f43b211768257f9ec7000f73078a2a6fab81863 100644 (file)
--- a/docs/build_system.rst
+++ b/docs/build-system.rst
@@ -131,7 +131,7 @@ Component Makefiles
 
 Each project contains one or more components, which can either be part of esp-idf or added from other component directories.
 
-A component is any sub-directory that contains a `component.mk` file.[#f1]_.
+A component is any sub-directory that contains a `component.mk` file [#f1]_.
 
 Minimal Component Makefile
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -464,7 +464,7 @@ The file's contents will be added to the .rodata section in flash, and are avail
 
 The names are generated from the full name of the file, as given in COMPONENT_EMBED_FILES. Characters /, ., etc. are replaced with underscores. The _binary prefix in the symbol name is added by objcopy and is the same for both text and binary files.
 
-For an example of using this technique, see examples/protocols/https_request - the certificate file contents are loaded from the text .pem file at compile time.
+For an example of using this technique, see `examples/protocols/https_request <https://github.com/espressif/esp-idf/tree/master/examples/protocols/https_request>`_ - the certificate file contents are loaded from the text .pem file at compile time.
 
 
 Fully Overriding The Component Makefile
@@ -485,7 +485,7 @@ is set then the component can instruct the linker to link other binaries instead
 
 .. _esp-idf-template: https://github.com/espressif/esp-idf-template
 .. _GNU Make Manual: https://www.gnu.org/software/make/manual/make.html
-.. _[_f1]: Actually, some components in esp-idf are "pure configuration" components that don't have a component.mk file, only a Makefile.projbuild and/or Kconfig.projbuild file. However, these components are unusual and most components have a component.mk file.
+.. [#f1] Actually, some components in esp-idf are "pure configuration" components that don't have a component.mk file, only a Makefile.projbuild and/or Kconfig.projbuild file. However, these components are unusual and most components have a component.mk file.
 
 
 Custom sdkconfig defaults

diff --git a/docs/index.rst b/docs/index.rst
index d1072b65112a03b65378416262e6c488d58fed0c..b934472b595fb5638eef2b17cf03f95cb3e1f062 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -28,7 +28,7 @@ Contents:
    :maxdepth: 1
 
    General Notes <general-notes>
-   Build System <build_system>
+   Build System <build-system>
    Debugging <openocd>
    ESP32 Core Dump <core_dump>
    Partition Tables <partition-tables>

diff --git a/docs/security/flash-encryption.rst b/docs/security/flash-encryption.rst
index 298a0a75bf67cd2fe7d05b29e68f96a0a09f2f42..8c6bd4c857eeb9fd8f853c223fd72a334df9d656 100644 (file)
--- a/docs/security/flash-encryption.rst
+++ b/docs/security/flash-encryption.rst
@@ -291,11 +291,13 @@ Flash Encryption Algorithm
 - Each 32 byte block is encrypted with a unique key which is derived from this main flash encryption key XORed with the offset of this block in the flash (a "key tweak").
 
 - The specific tweak depends on the setting of ``FLASH_CRYPT_CONFIG`` efuse. This is a 4 bit efuse, where each bit enables XORing of a particular range of the key bits:
+
   - Bit 1, bits 0-66 of the key are XORed.
   - Bit 2, bits 67-131 of the key are XORed.
   - Bit 3, bits 132-194 of the key are XORed.
   - Bit 4, bits 195-256 of the key are XORed.
-It is recommended that ``FLASH_CRYPT_CONFIG`` is always left to set the default value `0xF`, so that all key bits are XORed with the block offset. See `Setting FLASH_CRYPT_CONFIG` for details.
+
+  It is recommended that ``FLASH_CRYPT_CONFIG`` is always left to set the default value `0xF`, so that all key bits are XORed with the block offset. See `Setting FLASH_CRYPT_CONFIG` for details.
 
 - The high 19 bits of the block offset (bit 5 to bit 23) are XORed with the main flash encryption key. This range is chosen for two reasons: the maximum flash size is 16MB (24 bits), and each block is 32 bytes so the least significant 5 bits are always zero.
 

diff --git a/examples/storage/sd_card/README.md b/examples/storage/sd_card/README.md
index bfc6a39fe9730ebd500640f75bfe4562adb73b8b..b125716eaeb0e8039d6e0c0baad47d5a23ea136f 100644 (file)
--- a/examples/storage/sd_card/README.md
+++ b/examples/storage/sd_card/README.md
@@ -32,7 +32,8 @@ N/C           | WP          |
 This example doesn't utilize card detect (CD) and write protect (WP) signals from SD card slot.
 
 ### Note about GPIO2
-GPIO2 pin is used as a bootstrapping pin, and should be low to enter UART download mode. One way to do this is to connect GPIO0 and GPIO2 using a jumper, and then the auto-reset circuit on most development boards will pull GPIO2 low along with GPIO2, when entering download mode.
+
+GPIO2 pin is used as a bootstrapping pin, and should be low to enter UART download mode. One way to do this is to connect GPIO0 and GPIO2 using a jumper, and then the auto-reset circuit on most development boards will pull GPIO2 low along with GPIO0, when entering download mode.
 
 ### Note about GPIO12