Skip to content

Commit 331473a

Browse files
authored
Merge pull request #14589 from plan-do-break-fix/Typo-corrections
fix(docs): corrects various typos in project documentation
2 parents 2bf648f + 915b45a commit 331473a

File tree

15 files changed

+34
-34
lines changed

15 files changed

+34
-34
lines changed

TEST_APPS/testcases/nfc/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# NFC tests.
22

3-
A CI test suite for NFC component. These tests validate card mbed emulation cases. The key use case is an NFC smart poster supporting comissioning workflow.
3+
A CI test suite for NFC component. These tests validate card mbed emulation cases. The key use case is an NFC smart poster supporting commissioning workflow.
44
The SUT (system under test) is the NFC target. Tests exercise the framework and NDEF transactions when a NFC controller driver is used, or when the stack is configured for an NFC EEPROM chip in the system integration.
55

66
This project is called CreamScone, which is an ice tea framework based cli-driven python test.
@@ -42,7 +42,7 @@ Not in scope. Test procedures using a mobile phone app for Android and for IOS w
4242

4343
![Basic Overview](img/simple-overview.png)
4444

45-
Because the comissioning workflow application quality is the end goal, the NFC suite includes learnings to design the CI setup needed for future system testing that bring a mobile phone into the test-rig. The use of a mobile and bluetooth pairing as well as the continous integration system is not included.
45+
Because the commissioning workflow application quality is the end goal, the NFC suite includes learnings to design the CI setup needed for future system testing that bring a mobile phone into the test-rig. The use of a mobile and bluetooth pairing as well as the continuous integration system is not included.
4646

4747

4848

@@ -288,7 +288,7 @@ NFCProcessController::NFCProcessController(events::EventQueue &queue) :
288288
}
289289
```
290290
1. You will want to replace this and reference the desired controller driver. Likewise, this code is where pinout changes have to be made if using the supplied Controller driver.
291-
2. Search for occurences of guard macros `#ifdef TARGET_PN512` , and `#endif`. Add a new guard macro and code for your specific controller driver at the same point.
291+
2. Search for occurrences of guard macros `#ifdef TARGET_PN512` , and `#endif`. Add a new guard macro and code for your specific controller driver at the same point.
292292

293293

294294
Note: If the target uses an EEPROM, it need not be powered/running, to be read, mbedOS is not running at that point.
@@ -333,4 +333,4 @@ You can issue the command "getlastnfcerror help" to see a list of error codes th
333333

334334
1. Test test_nfce2e_discovery_loop fails on NFC controller. The NFC controller driver discovery loop cannot be stopped manually. No major functionality is lost, it only prevents a complete disable of NFC at runtime. A bug ticket #IOTPAN-313 was logged to fix the stop function. The Controller still restarts discovery loop normally under app control after a peer disconnects.
335335

336-
1. The smartposter NDEF record wrapper class `smartposter.h` is also provided as part of the NFC examples. The examples are not needed to compile the test app, but this example class may be usefull to customers. This file may thus move into the NFC component in future.
336+
1. The smartposter NDEF record wrapper class `smartposter.h` is also provided as part of the NFC examples. The examples are not needed to compile the test app, but this example class may be useful to customers. This file may thus move into the NFC component in future.

TEST_APPS/testcases/nfc/mobileapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A comparison of the SDKs exposed to manage NFC tags on Android IOs and Python mo
1515
<!-- /TOC -->
1616

1717
# Overview
18-
A comparison which analyses NFC use cases on mobile, as background to the test case design/implementation in the comissioning workflow :NFC-Bluetooth-pairing application.
18+
A comparison which analyses NFC use cases on mobile, as background to the test case design/implementation in the commissioning workflow :NFC-Bluetooth-pairing application.
1919
- Analyse the [Apple API](https://developer.apple.com/documentation/corenfc)
2020
- Analyse the [Android API](https://developer.android.com/guide/topics/connectivity/nfc/advanced-nfc#java)
2121
- Python test [pynfc modules](https://nfcpy.readthedocs.io/en/latest/modules/index.html)

connectivity/docs/Multihoming - Design document.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ From our point of view important function pointers are:
301301

302302
From LWIP documentation we can read.
303303

304-
**"output"** is called by the IP module when it wants to send a packet on the interface. It firts resolves the hardware address, then sends the packet. For ethernet physical layer, this is usually **etharp_output()**.
304+
**"output"** is called by the IP module when it wants to send a packet on the interface. It first resolves the hardware address, then sends the packet. For ethernet physical layer, this is usually **etharp_output()**.
305305

306306

307307
**"linkoutput"** is called by **ethernet_output()** when it wants to send a packet on the interface. This function outputs the pbuf as-is on the link medium.
@@ -579,7 +579,7 @@ Descriptor for **netconn** is shown below.
579579

580580
LWIP selects the proper netif on IP layer using **ip\_route**.
581581

582-
Currently it uses only ip adress as input parameter so choice is based on ip adress only. To extend choice ctiteria also to interface index **ip\_route** must be modified and must take desired **interface\_name** as second argument.
582+
Currently it uses only ip address as input parameter so choice is based on ip address only. To extend choice ctiteria also to interface index **ip\_route** must be modified and must take desired **interface\_name** as second argument.
583583
Therefore new member with information about **netif interface\_name** bound to current socket should be placed in the common part of all PCB types.
584584

585585

@@ -598,7 +598,7 @@ New member **char* interface\_name** should be add for binding socket to netif
598598

599599
## DNS changes
600600

601-
Currently in Nsapi_dns module there is only one array for 5 DNS server adresses.
601+
Currently in Nsapi_dns module there is only one array for 5 DNS server addresses.
602602

603603
static nsapi_addr_t dns_servers[DNS_SERVERS_SIZE] = {
604604
{NSAPI_IPv4, {8, 8, 8, 8}}, // Google
@@ -617,7 +617,7 @@ It can be done as below.
617617

618618
Add interface name as option to DNS query
619619

620-
To resolve IP adress Netsocket module uses following functions
620+
To resolve IP address Netsocket module uses following functions
621621

622622
gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
623623
nsapi_dns_query(NetworkStack *stack, const char *host, SocketAddress *address, nsapi_version_t version)

connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To port your CC 310 driver to Mbed OS on your specific target:
2828

2929
## Enabling optional alternative drivers
3030

31-
Three additional modules that are not enabled by default have alternative implementation support. This allows backward compatability because these modules don't have full functionality and returns `MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED` for some features. The modules are:
31+
Three additional modules that are not enabled by default have alternative implementation support. This allows backward compatibility because these modules don't have full functionality and returns `MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED` for some features. The modules are:
3232

3333
* `AES`, which only supports 128 bit key size, as opposed to previous support for all key sizes.
3434
* `CMAC`, which only supports AES 128 bit key size, as opposed to previous support for DES and all key sizes.

connectivity/netsocket/tests/TESTS/netsocket/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1372,7 +1372,7 @@ All `recvfrom()` calls return the same sized packet that was sent with same cont
13721372

13731373
Calculate packet loss rate. The maximum tolerated packet loss rate is 30%.
13741374

1375-
The number of succesful rounds is higher than 70.
1375+
The number of successful rounds is higher than 70.
13761376

13771377
### UDPSOCKET_ECHOTEST_BURST_NONBLOCK
13781378

@@ -1411,7 +1411,7 @@ All `recvfrom()` calls return the same sized packet that was sent with the same
14111411

14121412
Calculate packet loss rate. The maximum tolerated packet loss rate is 30%.
14131413

1414-
The number of succesful rounds is higher than 70.
1414+
The number of successful rounds is higher than 70.
14151415

14161416
### TCPSOCKET_ECHOTEST_BURST
14171417

connectivity/netsocket/tests/TESTS/network/wifi/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ This must be a first test to run after constructing the driver. No credentials s
140140

141141
**Precondition:**
142142

143-
Test the enviroment is set up as specified in the "Test Environment" chapter.
143+
Test the environment is set up as specified in the "Test Environment" chapter.
144144

145145
**Test steps:**
146146

@@ -245,7 +245,7 @@ API is a bit unclear whether 0 can also mean that driver does not support report
245245

246246
**Precondition:**
247247

248-
Test enviroment is set up as specified in "Test Environment" chapter.
248+
Test environment is set up as specified in "Test Environment" chapter.
249249

250250
**Test steps:**
251251

@@ -266,7 +266,7 @@ Test `WiFiInterface::connect(ssid, pass, security, channel)` with NULL parameter
266266

267267
**Precondition:**
268268

269-
Test enviroment is set up as specified in "Test Environment" chapter.
269+
Test environment is set up as specified in "Test Environment" chapter.
270270

271271
**Test steps:**
272272

@@ -286,7 +286,7 @@ Test `WiFiInterface::connect(ssid, pass, security)` with valid parameters for se
286286

287287
**Preconditions:**
288288

289-
Test enviroment is set up as specified in the "Test Environment" chapter.
289+
Test environment is set up as specified in the "Test Environment" chapter.
290290

291291
**Test steps:**
292292

@@ -308,7 +308,7 @@ This test only applies to devices that support selecting the channel (passes `WI
308308

309309
**Precondition:**
310310

311-
Test enviroment is set up as specified in the "Test Environment" chapter.
311+
Test environment is set up as specified in the "Test Environment" chapter.
312312

313313
**Test steps:**
314314

@@ -330,7 +330,7 @@ This test only applies to devices that support selecting the channel (passes `WI
330330

331331
**Precondition:**
332332

333-
Test enviroment is set up as specified in the "Test Environment" chapter.
333+
Test environment is set up as specified in the "Test Environment" chapter.
334334

335335
**Test steps:**
336336

@@ -350,7 +350,7 @@ Test `WiFiInterface::connect()` without parameters. Use `set_credentials()` for
350350

351351
**Preconditions:**
352352

353-
1. Test enviroment is set up as specified in the "Test Environment" chapter.
353+
1. Test environment is set up as specified in the "Test Environment" chapter.
354354

355355
**Test steps:**
356356

@@ -378,7 +378,7 @@ Test `WiFiInterface::connect()` and `WiFiInterface::disconnect()` in non-blockin
378378

379379
**Preconditions:**
380380

381-
1. Test enviroment is set up as specified in the "Test Environment" chapter.
381+
1. Test environment is set up as specified in the "Test Environment" chapter.
382382

383383
**Test steps:**
384384

@@ -411,7 +411,7 @@ Test `WiFiInterface::connect()` without parameters. Use secure settings for `set
411411

412412
**Precondition:**
413413

414-
The test enviroment is set up as specified in the "Test Environment" chapter.
414+
The test environment is set up as specified in the "Test Environment" chapter.
415415

416416
**Test steps:**
417417

@@ -432,7 +432,7 @@ The `connect()` call returns `NSAPI_ERROR_OK`.
432432

433433
**Precondition:**
434434

435-
The test enviroment is set up as specified in the "Test Environment" chapter.
435+
The test environment is set up as specified in the "Test Environment" chapter.
436436

437437
**Test steps:**
438438

@@ -453,7 +453,7 @@ Test `WiFiInterface::connect()` - `disconnect()` repetition works.
453453

454454
**Precondition:**
455455

456-
The test enviroment is set up as specified in the "Test Environment" chapter.
456+
The test environment is set up as specified in the "Test Environment" chapter.
457457

458458
**Test steps:**
459459

@@ -477,7 +477,7 @@ Call `WiFiInterface::scan()` with null parameters to get the number of networks
477477

478478
**Precondition:**
479479

480-
The test enviroment is set up as specified in the "Test Environment" chapter.
480+
The test environment is set up as specified in the "Test Environment" chapter.
481481

482482
**Test steps:**
483483

@@ -496,7 +496,7 @@ The test enviroment is set up as specified in the "Test Environment" chapter.
496496

497497
**Preconditions:**
498498

499-
1. The test enviroment is set up as specified in the "Test Environment" chapter.
499+
1. The test environment is set up as specified in the "Test Environment" chapter.
500500
2. The test environment must contain less than 10 Wi-Fi SSID within the listening range of DUT; otherwise, adjust the value used in step 2.
501501

502502
**Test steps:**

connectivity/nfc/docs/nfc_design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ List the RF protocols that have been activated to communicate with that endpoint
298298
virtual void on_connected();
299299
```
300300

301-
This is called when a connection to this endpoint is succesfully established.
301+
This is called when a connection to this endpoint is successfully established.
302302

303303
```cpp
304304
virtual void on_disconnected();

docs/design-documents/design_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Detailed API description, such as the signature of the interface, explanation of
8686
And the function should return mbed_error_status_t value indicating the result of the call as below:
8787
MBED_SUCCESS if the call is successful.
8888
MBED_ERROR_INVALID_ARGUMENT if input values are invalid.`
89-
MBED_ERROR_CONFIG_UNSUPPORTED if the device doesnt support the requested configuration.`
89+
MBED_ERROR_CONFIG_UNSUPPORTED if the device doesn't support the requested configuration.`
9090

9191
**Configuration sequence diagram**
9292

drivers/usb/tests/TESTS/usb_device/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ No setup method has been verified for this platform.
6868
6969
## Running tests
7070
1. Plug both USB interfaces (*DAPLink* and *USB device*) to your host machine.
71-
1. An addtional macro `USB_DEVICE_TESTS` is needed to be defined when runing tests:
71+
1. An additional macro `USB_DEVICE_TESTS` is needed to be defined when running tests:
7272
```
7373
mbed test -t <toolchain> -m <target> -DUSB_DEVICE_TESTS -n *-tests-usb_device-*
7474
```

platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/TESTS/compliance_its/psa_its_testlist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Following are the requirements of the Storage Test Suite. <br />
66

77
1. Unless described in this document, any behaviour that is defined as IMPLEMENTATION_DEFINED in PSA Storage API document is not verified in this document. <br />
8-
2. Storage Test Cases use UID value starting from 1 onwards. These UID needs to be free for successfull test execution.<br />
8+
2. Storage Test Cases use UID value starting from 1 onwards. These UID needs to be free for successful test execution.<br />
99
3. UID values 1 and 2 are reserved as WRITE_ONCE UID.These UID can't be free from testcase. Make sure these are free.<br />
1010

1111

platform/docs/clocks/clocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Unlike direct clock access, those high-level classes always handle deep sleep lo
133133

134134
There is also a generic `TickerDataClock` which provides a Chrono Clock wrapper for a `ticker_data *`, so that `TickerDataClock::time_point` can be used to express absolute times for arbitrary clocks.
135135

136-
Note that the `TickerDataClock` is a non-standard Chrono clock, in that its `now` method is non-static. The Chrono type-checking will not detect that `TickerDataClock::time_point`s for different tickers are not interchangable. It is generally preferable to use the dedicated `HighResClock` or `LowPowerClock`, but `TickerDataClock` is used by some generic code, to avoid template bloat from separate code for each Clock.
136+
Note that the `TickerDataClock` is a non-standard Chrono clock, in that its `now` method is non-static. The Chrono type-checking will not detect that `TickerDataClock::time_point`s for different tickers are not interchangeable. It is generally preferable to use the dedicated `HighResClock` or `LowPowerClock`, but `TickerDataClock` is used by some generic code, to avoid template bloat from separate code for each Clock.
137137

138138
The base classes `TimerBase`, `TickerBase` and `TimeoutBase` use `TickerDataClock` to provide the core of the high-level implementation, and these are then used to provide the separate strongly-typed high-resolution and low-power classes above.
139139

platform/docs/crash-reporting/crash_reporting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ typedef struct _mbed_error_ctx {
9999
...
100100
101101
//Below are the new struct members
102-
int32_t error_reboot_count; //everytime we write this struct we increment this value by 1, irrespective of time between reboots. Note that the data itself might change, but everytime we reboot due to error we update this count by 1
102+
int32_t error_reboot_count; //every time we write this struct we increment this value by 1, irrespective of time between reboots. Note that the data itself might change, but every time we reboot due to error we update this count by 1
103103
int32_t is_error_processed; //once this error is processed set this value to 1
104104
uint32_t crc_error_ctx; //crc_error_ctx should always be the last member in this struct
105105
} mbed_error_ctx;

platform/docs/memory-model/ram_memory_model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ This feature will be implemented in different phases as follow:
8080

8181
Phase 1 (5.12 Release):
8282
1. Adopt 2-region memory model for Stack and Heap memory.
83-
1. Unify the stack size accross all targets (RTOS: ISR stack - 1K Main thread Stack - 4K; Bare Metal(No RTOS) ISR/Main Stack - 4K)
83+
1. Unify the stack size across all targets (RTOS: ISR stack - 1K Main thread Stack - 4K; Bare Metal(No RTOS) ISR/Main Stack - 4K)
8484

8585
Phase 2:
8686
1. Heap memory to be dynamic and starts at the end of ZI growing up till end of RAM memory (In case of single RAM bank)

storage/filesystem/littlefs/littlefs/DESIGN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,7 @@ So, as a solution, the littlefs adopted a sort of threaded tree. Each
624624
directory not only contains pointers to all of its children, but also a
625625
pointer to the next directory. These pointers create a linked-list that
626626
is threaded through all of the directories in the filesystem. Because we
627-
only use this linked list to check for existance, the order doesn't actually
627+
only use this linked list to check for existence, the order doesn't actually
628628
matter. As an added plus, we can repurpose the pointer for the individual
629629
directory linked-lists and avoid using any additional space.
630630

tools/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Quick navigation:
2222
| `importer` | code importer for use with CMSIS, TFM/PSA etc. |
2323
| `libraries.py` | constants for building mbed 2 libraries |
2424
| `make.py` | implementation of `mbed compile` |
25-
| `memap.py` | map file parser and sumary generator |
25+
| `memap.py` | map file parser and summary generator |
2626
| `notifier` | API for seting compile status to a frontend |
2727
| `options.py` | Default option parser and option utilities |
2828
| `paths.py` | constants for many paths used |

0 commit comments

Comments
 (0)