Skip to content

Commit

Permalink
Final set of spelling fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Andras Fekete committed Oct 7, 2024
1 parent 4c84069 commit 6d16fa1
Show file tree
Hide file tree
Showing 40 changed files with 64 additions and 57 deletions.
9 changes: 8 additions & 1 deletion .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,11 @@ jobs:
check_filenames: true
check_hidden: true
# Add comma separated list of words to ignore (sorted alphabetically, case sensitive)
ignore_words_list: adin,ADn,aNULL,carryIn,cconfiguration,chainG,ciph,cLen,cliKs,creen,dout,ede,endianess,Endianess,Fo,haveA,hashIn,larg,LEAPYEAR,inCreated,inOut,inout,Merget,mot,optionA,optmization,parm,parms,rIn,ser,siz,Te,te,TOOM,userA,vie,vlaue
ignore_words_list: adin,ADn,alph,aNULL,carryIn,cconfiguration,chainG,ciph,cLen,cliKs,creen,dout,ede,endianess,Endianess,Fo,haveA,hashIn,larg,LEAPYEAR,inCreated,inOut,inout,Merget,mot,optionA,optmization,parm,parms,rIn,rsource,ser,siz,Te,te,TOOM,userA,vie,vlaue
exclude_file:
./IDE/ECLIPSE/DEOS/tls_wolfssl.c
./IDE/ECLIPSE/MICRIUM/client_wolfssl.c
./IDE/IAR-MSP430/main.c
./tests/api.c
skip:
./certs/*/*.pem
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
# The maximum length of options is NOT 50 characters as documented.
# kconfcheck will complain that options should be 40 at most.
#
# Fix option lengths first. Superflous errors on other lines may occur.
# Fix option lengths first. Superfluous errors on other lines may occur.
#
# The maximum length of lines is 120 characters.
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -750,7 +750,7 @@
/***** END CONFIG_IDF_TARGET_ESP8684 *****/

#else
/* Anything else encountered, disable HW accleration */
/* Anything else encountered, disable HW acceleration */
#warning "Unexpected CONFIG_IDF_TARGET_NN value"
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ choice WOLFSSL_EXAMPLE_CHOOSE
config WOLFSSL_EXAMPLE_NAME_WOLFSSH_TEMPLATE
bool "SSH Template App"
help
Bare-bones Hellow World app that only compiles in wolfSSL and wolfSSH.
Bare-bones Hello World app that only compiles in wolfSSL and wolfSSH.
See wolfSSL/wolfssh on GitHub.

config WOLFSSL_EXAMPLE_NAME_WOLFSSH_ECHOSERVER
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ CFLAGS +=-DWOLFSSL_USER_SETTINGS
# the root is 7 directories up from here:
WOLFSSL_ROOT := ../../../../../../../

# NOTE: The wolfSSL include diretory (e.g. user_settings.h) is
# NOTE: The wolfSSL include directory (e.g. user_settings.h) is
# located HERE in THIS project, and *not* in the wolfSSL root.
COMPONENT_ADD_INCLUDEDIRS := .
COMPONENT_ADD_INCLUDEDIRS += include
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@
/***** END CONFIG_IDF_TARGET_ESP8684 *****/

#else
/* Anything else encountered, disable HW accleration */
/* Anything else encountered, disable HW acceleration */
#warning "Unexpected CONFIG_IDF_TARGET_NN value"
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ I (735) system_api: read default base MAC address from EFUSE
I (755) wifi:wifi firmware version: 0d470ef
I (755) wifi:wifi certification version: v7.0
I (755) wifi:config NVS flash: enabled
I (755) wifi:config nano formating: disabled
I (755) wifi:config nano formatting: disabled
I (755) wifi:Init data frame dynamic rx buffer num: 32
I (765) wifi:Init management frame dynamic rx buffer num: 32
I (765) wifi:Init management short buffer num: 32
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ WOLFSSL_ROOT := ../../../../../../..
# "/mnt/c" is 4 directories up:
# 2 for `./test/demo` from where we run `make`, plus
# 2 more from the location of `component.mk` located
# in `[currect directory]/components/wolfssl`.
# in `[current directory]/components/wolfssl`.
#
# Thus we need 4 parent reference to find the relative path to wolfSSL:
# WOLFSSL_ROOT := ../../../../workspace/wolfssl-master
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@
/***** END CONFIG_IDF_TARGET_ESP8684 *****/

#else
/* Anything else encountered, disable HW accleration */
/* Anything else encountered, disable HW acceleration */
#warning "Unexpected CONFIG_IDF_TARGET_NN value"
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ WOLFSSL_ESP_TASK tls_smp_client_task(void* args);

/* init will create an RTOS task, otherwise server is simply function call. */
#if defined(SINGLE_THREADED)
/* no init neded */
/* no init needed */
#else
WOLFSSL_ESP_TASK tls_smp_client_init(void* args);
#endif
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
** the config you want - ie #define EXAMPLE_WIFI_SSID "mywifissid"
*/
#if defined(CONFIG_ESP_WIFI_SSID)
/* tyically from ESP32 with ESP-IDF v4 ot v5 */
/* tyically from ESP32 with ESP-IDF v4 to v5 */
#define EXAMPLE_ESP_WIFI_SSID CONFIG_ESP_WIFI_SSID
#elif defined(CONFIG_EXAMPLE_WIFI_SSID)
/* tyically from ESP8266 rtos-sdk/v3.4 */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ int set_time_from_string(const char* time_buffer)
&day, &hour, &minute, &second, &year, &offset);

if (ret == 8) {
/* we found a match for all componets */
/* we found a match for all components */

const char *months[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
"Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
Expand Down Expand Up @@ -264,7 +264,7 @@ int set_time(void)
esp_show_current_datetime();

#ifdef LIBWOLFSSL_VERSION_GIT_HASH_DATE
/* initialy set a default approximate time from recent git commit */
/* initially set a default approximate time from recent git commit */
ESP_LOGI(TAG, "Found git hash date, attempting to set system date: %s",
LIBWOLFSSL_VERSION_GIT_HASH_DATE);
set_time_from_string(LIBWOLFSSL_VERSION_GIT_HASH_DATE"\0");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ int wifi_init_sta(void)
};

/* Setting a password implies station will connect to all security modes including WEP/WPA.
* However these modes are deprecated and not advisable to be used. Incase your Access point
* However these modes are deprecated and not advisable to be used. In case your Access point
* doesn't support WPA2, these mode can be enabled by commenting below line */

if (strlen((char *)wifi_config.sta.password)) {
Expand Down Expand Up @@ -315,7 +315,7 @@ int wifi_init_sta(void)
.ssid = EXAMPLE_ESP_WIFI_SSID,
.password = EXAMPLE_ESP_WIFI_PASS,
/* Authmode threshold resets to WPA2 as default if password matches
* WPA2 standards (pasword len => 8). If you want to connect the
* WPA2 standards (password len => 8). If you want to connect the
* device to deprecated WEP/WPA networks, Please set the threshold
* value WIFI_AUTH_WEP/WIFI_AUTH_WPA_PSK and set the password with
* length and format matching to WIFI_AUTH_WEP/WIFI_AUTH_WPA_PSK
Expand Down
2 changes: 1 addition & 1 deletion IDE/Espressif/ESP-IDF/examples/wolfssl_server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ After the server exits, remove the port proxy forward:
netsh interface portproxy delete v4tov4 listenport=11111 listenaddress=0.0.0.0
```

Cipers to consider
Ciphers to consider

```
TLS13-AES128-GCM-SHA256:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ I (735) system_api: read default base MAC address from EFUSE
I (755) wifi:wifi firmware version: 0d470ef
I (755) wifi:wifi certification version: v7.0
I (755) wifi:config NVS flash: enabled
I (755) wifi:config nano formating: disabled
I (755) wifi:config nano formatting: disabled
I (755) wifi:Init data frame dynamic rx buffer num: 32
I (765) wifi:Init management frame dynamic rx buffer num: 32
I (765) wifi:Init management short buffer num: 32
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ CFLAGS +=-DWOLFSSL_USER_SETTINGS
# The root is 7 directories up from here:
WOLFSSL_ROOT := ../../../../../../..

# NOTE: The wolfSSL include diretory (e.g. user_settings.h) is
# NOTE: The wolfSSL include directory (e.g. user_settings.h) is
# located HERE in THIS project, and *not* in the wolfSSL root.
COMPONENT_ADD_INCLUDEDIRS := ./include
COMPONENT_ADD_INCLUDEDIRS += $(WOLFSSL_ROOT)/.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@
/***** END CONFIG_IDF_TARGET_ESP8684 *****/

#else
/* Anything else encountered, disable HW accleration */
/* Anything else encountered, disable HW acceleration */
#warning "Unexpected CONFIG_IDF_TARGET_NN value"
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ WOLFSSL_ESP_TASK tls_smp_server_task(void *args);

/* init will create an RTOS task, otherwise server is simply function call. */
#if defined(SINGLE_THREADED)
/* no init neded */
/* no init needed */
#else
WOLFSSL_ESP_TASK tls_smp_server_init(void* args);
#endif
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ int set_time_from_string(char* time_buffer)
&day, &hour, &minute, &second, &year, &offset);

if (ret == 8) {
/* we found a match for all componets */
/* we found a match for all components */

const char *months[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
"Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
Expand Down Expand Up @@ -223,7 +223,7 @@ int set_time(void)
esp_show_current_datetime();

#ifdef LIBWOLFSSL_VERSION_GIT_HASH_DATE
/* initialy set a default approximate time from recent git commit */
/* initially set a default approximate time from recent git commit */
ESP_LOGI(TAG, "Found git hash date, attempting to set system date.");
set_time_from_string(LIBWOLFSSL_VERSION_GIT_HASH_DATE);
esp_show_current_datetime();
Expand Down Expand Up @@ -322,7 +322,7 @@ int set_time_wait_for_ntp(void)
#endif

if (ret == ESP_OK) {
ESP_LOGI(TAG, "Successfuly set time via NTP servers.");
ESP_LOGI(TAG, "Successfully set time via NTP servers.");
}
else {
ESP_LOGW(TAG, "Warning: Failed to set time with NTP: "
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ int wifi_init_sta(void)
.ssid = EXAMPLE_ESP_WIFI_SSID,
.password = EXAMPLE_ESP_WIFI_PASS,
/* Authmode threshold resets to WPA2 as default if password matches
* WPA2 standards (pasword len => 8). If you want to connect the
* WPA2 standards (password len => 8). If you want to connect the
* device to deprecated WEP/WPA networks, Please set the threshold
* value WIFI_AUTH_WEP/WIFI_AUTH_WPA_PSK and set the password with
* length and format matching to WIFI_AUTH_WEP/WIFI_AUTH_WPA_PSK
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@
/***** END CONFIG_IDF_TARGET_ESP8684 *****/

#else
/* Anything else encountered, disable HW accleration */
/* Anything else encountered, disable HW acceleration */
#warning "Unexpected CONFIG_IDF_TARGET_NN value"
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
Expand Down
4 changes: 2 additions & 2 deletions IDE/Espressif/ESP-IDF/user_settings.h
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@
#define NO_WOLFSSL_ESP32_CRYPT_RSA_PRI
/***** END CONFIG_IDF_TARGET_ESP266 *****/
#else
/* Anything else encountered, disable HW accleration */
/* Anything else encountered, disable HW acceleration */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
Expand Down Expand Up @@ -359,7 +359,7 @@

/* #define HASH_SIZE_LIMIT */ /* for test.c */

/* #define NO_HW_MATH_TEST */ /* Optionall turn off HW math checks */
/* #define NO_HW_MATH_TEST */ /* Optionally turn off HW math checks */

/* Optionally include alternate HW test library: alt_hw_test.h */
/* When enabling, the ./components/wolfssl/CMakeLists.txt file
Expand Down
2 changes: 1 addition & 1 deletion IDE/IAR-EWARM/Projects/benchmark/wolfCrypt-benchmark.ewp
Original file line number Diff line number Diff line change
Expand Up @@ -937,7 +937,7 @@
</option>
<option>
<name>IarchiveOutput</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
</data>
</settings>
Expand Down
4 changes: 2 additions & 2 deletions IDE/IAR-EWARM/Projects/lib/wolfSSL-Lib.ewp
Original file line number Diff line number Diff line change
Expand Up @@ -1593,7 +1593,7 @@
</option>
<option>
<name>IlinkOutputFile</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
<option>
<name>IlinkDebugInfoEnable</name>
Expand Down Expand Up @@ -1879,7 +1879,7 @@
</option>
<option>
<name>IarchiveOutput</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
</data>
</settings>
Expand Down
2 changes: 1 addition & 1 deletion IDE/IAR-EWARM/Projects/test/wolfCrypt-test.ewp
Original file line number Diff line number Diff line change
Expand Up @@ -937,7 +937,7 @@
</option>
<option>
<name>IarchiveOutput</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
</data>
</settings>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -958,7 +958,7 @@
</option>
<option>
<name>IarchiveOutput</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
</data>
</settings>
Expand Down Expand Up @@ -1627,7 +1627,7 @@
</option>
<option>
<name>IlinkOutputFile</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
<option>
<name>IlinkDebugInfoEnable</name>
Expand Down Expand Up @@ -1917,7 +1917,7 @@
</option>
<option>
<name>IarchiveOutput</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
</data>
</settings>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1624,7 +1624,7 @@
</option>
<option>
<name>IlinkOutputFile</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
<option>
<name>IlinkDebugInfoEnable</name>
Expand Down Expand Up @@ -1914,7 +1914,7 @@
</option>
<option>
<name>IarchiveOutput</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
</data>
</settings>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -958,7 +958,7 @@
</option>
<option>
<name>IarchiveOutput</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
</data>
</settings>
Expand Down Expand Up @@ -1627,7 +1627,7 @@
</option>
<option>
<name>IlinkOutputFile</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
<option>
<name>IlinkDebugInfoEnable</name>
Expand Down Expand Up @@ -1917,7 +1917,7 @@
</option>
<option>
<name>IarchiveOutput</name>
<state>###Unitialized###</state>
<state>###Uninitialized###</state>
</option>
</data>
</settings>
Expand Down
2 changes: 1 addition & 1 deletion IDE/MPLABX16/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ steps below to generate that code.
2. Set the Project path to the wolfSSL/IDE/MPLABX16 and enter your PIC device
into the interface.

3. Select MCC Clasic as the content type and click `Finish`.
3. Select MCC Classic as the content type and click `Finish`.

4. Under the Device Resources section, find the UART entry and add the UART1
peripheral.
Expand Down
2 changes: 1 addition & 1 deletion IDE/MPLABX16/wolfssl.X/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
# clean remove built files from a configuration
# clobber remove all built files
# all build all configurations
# help print help mesage
# help print help message
#
# Targets .build-impl, .clean-impl, .clobber-impl, .all-impl, and
# .help-impl are implemented in nbproject/makefile-impl.mk.
Expand Down
2 changes: 1 addition & 1 deletion IDE/Renesas/e2studio/RA6M3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The following steps explain how to generate the missing files and where to place
|Thread Symbol|wolfssl_tst_thread|
|Thread Name|wolf_tst_thread|
|Thread Stack size|increase depending on your environment<br> e.g. 0xA000|
|Thread MemoryAllocation|Dyamic|
|Thread MemoryAllocation|Dynamic|
|Common General Use Mutexes|Enabled|
|Common General Enable Backward Compatibility|Enabled|
|Common Memory Allocation Support Dynamic Allocation|Enabled|
Expand Down
2 changes: 1 addition & 1 deletion IDE/Renesas/e2studio/RA6M4/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The wolfssl Project Summary is listed below and is relevant for every project.
|Thread Symbol|sce_tst_thread|
|Thread Name|sce_tst_thread|
|Thread Stack size|increase depending on your environment<br> e.g. 0xA000|
|Thread MemoryAllocation|Dyamic|
|Thread MemoryAllocation|Dynamic|
|Common General Use Mutexes|Enabled|
|Common General Enable Backward Compatibility|Enabled|
|Common Memory Allocation Support Dynamic Allocation|Enabled|
Expand Down
Loading

0 comments on commit 6d16fa1

Please sign in to comment.