Skip to content

Commit 683b8e6

Browse files
authored
Fix spelling typos in files under doc/esp8266wifi (#7520)
This patch fixes some spelling typos in following files bearssl-client-secure-class.rst client-class.rst scan-class.rst scan-examples.rst server-examples.rst
1 parent 6feda9e commit 683b8e6

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

doc/esp8266wifi/bearssl-client-secure-class.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ setFingerprint(const uint8_t fp[20]) / setFingerprint(const char \*fpStr)
139139

140140
Verify the SHA1 fingerprint of the certificate returned matches this one. If the server certificate changes, it will fail. If an array of 20 bytes are sent in, it is assumed they are the binary SHA1 values. If a `char*` string is passed in, it is parsed as a series of human-readable hex values separated by spaces or colons (e.g. `setFingerprint("00:01:02:03:...:1f");`)
141141

142-
This fingerprint is calcuated on the raw X509 certificate served by the server. In very rare cases, these certificates have certain encodings which should be normalized before taking a fingerprint (but in order to preserve memory BearSSL does not do this normalization since it would need RAM for an entire copy of the cert), and the fingerprint BearSSL calculates will not match the fingerprint OpenSSL calculates. In this case, you can enable SSL debugging and get a dump of BearSSL's calculated fingerprint and use that one in your code, or use full certificate validation. See the `original issue and debug here <https://github.com/esp8266/Arduino/issues/6209>`__.
142+
This fingerprint is calculated on the raw X509 certificate served by the server. In very rare cases, these certificates have certain encodings which should be normalized before taking a fingerprint (but in order to preserve memory BearSSL does not do this normalization since it would need RAM for an entire copy of the cert), and the fingerprint BearSSL calculates will not match the fingerprint OpenSSL calculates. In this case, you can enable SSL debugging and get a dump of BearSSL's calculated fingerprint and use that one in your code, or use full certificate validation. See the `original issue and debug here <https://github.com/esp8266/Arduino/issues/6209>`__.
143143

144144
setTrustAnchors(BearSSL::X509List \*ta)
145145
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

doc/esp8266wifi/client-class.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ In this mode, every ``write()`` is flushed. It means that after a call to
6161

6262
When set to ``true`` in ``WiFiClient`` implementation,
6363

64-
- It slows down transfers, and implicitely disable the Nagle algorithm.
64+
- It slows down transfers, and implicitly disable the Nagle algorithm.
6565

6666
- It also allows to avoid a temporary copy of data that otherwise consumes
6767
at most ``TCP_SND_BUF`` = (2 * ``MSS``) bytes per connection,

doc/esp8266wifi/scan-class.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ Return information if a network discovered during the scan is hidden or not.
191191
192192
WiFi.isHidden(networkItem)
193193
194-
Returned value if the ``bolean`` type, and ``true`` means that network is hidden. The ``networkItem`` is a zero based index of network discovered during scan.
194+
Returned value if the ``boolean`` type, and ``true`` means that network is hidden. The ``networkItem`` is a zero based index of network discovered during scan.
195195

196196
getNetworkInfo
197197
^^^^^^^^^^^^^^

doc/esp8266wifi/scan-examples.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ Complete sketch is below. The code inside ``setup()`` is the same as described i
206206
lastScanMillis = currentMillis;
207207
}
208208
209-
// print out Wi-Fi network scan result uppon completion
209+
// print out Wi-Fi network scan result upon completion
210210
int n = WiFi.scanComplete();
211211
if(n >= 0)
212212
{

doc/esp8266wifi/server-examples.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ Complete sketch is presented below.
204204
205205
// close the connection:
206206
client.stop();
207-
Serial.println("[Client disonnected]");
207+
Serial.println("[Client disconnected]");
208208
}
209209
}
210210
@@ -236,7 +236,7 @@ The page would be refreshed every 5 seconds. Each time this happens, you should
236236
Host: 192.168.1.104
237237
DNT: 1
238238
Connection: Keep-Alive
239-
[client disonnected]
239+
[client disconnected]
240240

241241
Conclusion
242242
~~~~~~~~~~

0 commit comments

Comments
 (0)