Skip to content

Commit

Permalink
Merge pull request #14589 from plan-do-break-fix/Typo-corrections
Browse files Browse the repository at this point in the history
fix(docs): corrects various typos in project documentation
  • Loading branch information
0xc0170 committed Apr 28, 2021
2 parents 2bf648f + 915b45a commit 331473a
Show file tree
Hide file tree
Showing 15 changed files with 34 additions and 34 deletions.
8 changes: 4 additions & 4 deletions TEST_APPS/testcases/nfc/README.md
@@ -1,6 +1,6 @@
# NFC tests.

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.
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.
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.

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

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

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.
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.



Expand Down Expand Up @@ -288,7 +288,7 @@ NFCProcessController::NFCProcessController(events::EventQueue &queue) :
}
```
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.
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.
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.


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

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.

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.
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.
2 changes: 1 addition & 1 deletion TEST_APPS/testcases/nfc/mobileapi.md
Expand Up @@ -15,7 +15,7 @@ A comparison of the SDKs exposed to manage NFC tags on Android IOs and Python mo
<!-- /TOC -->

# Overview
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.
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.
- Analyse the [Apple API](https://developer.apple.com/documentation/corenfc)
- Analyse the [Android API](https://developer.android.com/guide/topics/connectivity/nfc/advanced-nfc#java)
- Python test [pynfc modules](https://nfcpy.readthedocs.io/en/latest/modules/index.html)
Expand Down
8 changes: 4 additions & 4 deletions connectivity/docs/Multihoming - Design document.md
Expand Up @@ -301,7 +301,7 @@ From our point of view important function pointers are:

From LWIP documentation we can read.

**"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()**.
**"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()**.


**"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.
Expand Down Expand Up @@ -579,7 +579,7 @@ Descriptor for **netconn** is shown below.

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

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.
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.
Therefore new member with information about **netif interface\_name** bound to current socket should be placed in the common part of all PCB types.


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

## DNS changes

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

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

Add interface name as option to DNS query

To resolve IP adress Netsocket module uses following functions
To resolve IP address Netsocket module uses following functions

gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
nsapi_dns_query(NetworkStack *stack, const char *host, SocketAddress *address, nsapi_version_t version)
Expand Down
Expand Up @@ -28,7 +28,7 @@ To port your CC 310 driver to Mbed OS on your specific target:

## Enabling optional alternative drivers

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:
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:

* `AES`, which only supports 128 bit key size, as opposed to previous support for all key sizes.
* `CMAC`, which only supports AES 128 bit key size, as opposed to previous support for DES and all key sizes.
Expand Down
4 changes: 2 additions & 2 deletions connectivity/netsocket/tests/TESTS/netsocket/README.md
Expand Up @@ -1372,7 +1372,7 @@ All `recvfrom()` calls return the same sized packet that was sent with same cont

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

The number of succesful rounds is higher than 70.
The number of successful rounds is higher than 70.

### UDPSOCKET_ECHOTEST_BURST_NONBLOCK

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

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

The number of succesful rounds is higher than 70.
The number of successful rounds is higher than 70.

### TCPSOCKET_ECHOTEST_BURST

Expand Down
26 changes: 13 additions & 13 deletions connectivity/netsocket/tests/TESTS/network/wifi/README.md
Expand Up @@ -140,7 +140,7 @@ This must be a first test to run after constructing the driver. No credentials s

**Precondition:**

Test the enviroment is set up as specified in the "Test Environment" chapter.
Test the environment is set up as specified in the "Test Environment" chapter.

**Test steps:**

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

**Precondition:**

Test enviroment is set up as specified in "Test Environment" chapter.
Test environment is set up as specified in "Test Environment" chapter.

**Test steps:**

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

**Precondition:**

Test enviroment is set up as specified in "Test Environment" chapter.
Test environment is set up as specified in "Test Environment" chapter.

**Test steps:**

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

**Preconditions:**

Test enviroment is set up as specified in the "Test Environment" chapter.
Test environment is set up as specified in the "Test Environment" chapter.

**Test steps:**

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

**Precondition:**

Test enviroment is set up as specified in the "Test Environment" chapter.
Test environment is set up as specified in the "Test Environment" chapter.

**Test steps:**

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

**Precondition:**

Test enviroment is set up as specified in the "Test Environment" chapter.
Test environment is set up as specified in the "Test Environment" chapter.

**Test steps:**

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

**Preconditions:**

1. Test enviroment is set up as specified in the "Test Environment" chapter.
1. Test environment is set up as specified in the "Test Environment" chapter.

**Test steps:**

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

**Preconditions:**

1. Test enviroment is set up as specified in the "Test Environment" chapter.
1. Test environment is set up as specified in the "Test Environment" chapter.

**Test steps:**

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

**Precondition:**

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

**Test steps:**

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

**Precondition:**

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

**Test steps:**

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

**Precondition:**

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

**Test steps:**

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

**Precondition:**

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

**Test steps:**

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

**Preconditions:**

1. The test enviroment is set up as specified in the "Test Environment" chapter.
1. The test environment is set up as specified in the "Test Environment" chapter.
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.

**Test steps:**
Expand Down
2 changes: 1 addition & 1 deletion connectivity/nfc/docs/nfc_design.md
Expand Up @@ -298,7 +298,7 @@ List the RF protocols that have been activated to communicate with that endpoint
virtual void on_connected();
```

This is called when a connection to this endpoint is succesfully established.
This is called when a connection to this endpoint is successfully established.

```cpp
virtual void on_disconnected();
Expand Down
2 changes: 1 addition & 1 deletion docs/design-documents/design_template.md
Expand Up @@ -86,7 +86,7 @@ Detailed API description, such as the signature of the interface, explanation of
And the function should return mbed_error_status_t value indicating the result of the call as below:
MBED_SUCCESS if the call is successful.
MBED_ERROR_INVALID_ARGUMENT if input values are invalid.`
MBED_ERROR_CONFIG_UNSUPPORTED if the device doesnt support the requested configuration.`
MBED_ERROR_CONFIG_UNSUPPORTED if the device doesn't support the requested configuration.`

**Configuration sequence diagram**

Expand Down
2 changes: 1 addition & 1 deletion drivers/usb/tests/TESTS/usb_device/README.md
Expand Up @@ -68,7 +68,7 @@ No setup method has been verified for this platform.
## Running tests
1. Plug both USB interfaces (*DAPLink* and *USB device*) to your host machine.
1. An addtional macro `USB_DEVICE_TESTS` is needed to be defined when runing tests:
1. An additional macro `USB_DEVICE_TESTS` is needed to be defined when running tests:
```
mbed test -t <toolchain> -m <target> -DUSB_DEVICE_TESTS -n *-tests-usb_device-*
```
Expand Down
Expand Up @@ -5,7 +5,7 @@
Following are the requirements of the Storage Test Suite. <br />

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 />
2. Storage Test Cases use UID value starting from 1 onwards. These UID needs to be free for successfull test execution.<br />
2. Storage Test Cases use UID value starting from 1 onwards. These UID needs to be free for successful test execution.<br />
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 />


Expand Down
2 changes: 1 addition & 1 deletion platform/docs/clocks/clocks.md
Expand Up @@ -133,7 +133,7 @@ Unlike direct clock access, those high-level classes always handle deep sleep lo

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.

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.
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.

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.

Expand Down
2 changes: 1 addition & 1 deletion platform/docs/crash-reporting/crash_reporting.md
Expand Up @@ -99,7 +99,7 @@ typedef struct _mbed_error_ctx {
...
//Below are the new struct members
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
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
int32_t is_error_processed; //once this error is processed set this value to 1
uint32_t crc_error_ctx; //crc_error_ctx should always be the last member in this struct
} mbed_error_ctx;
Expand Down
2 changes: 1 addition & 1 deletion platform/docs/memory-model/ram_memory_model.md
Expand Up @@ -80,7 +80,7 @@ This feature will be implemented in different phases as follow:

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

Phase 2:
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)
Expand Down
2 changes: 1 addition & 1 deletion storage/filesystem/littlefs/littlefs/DESIGN.md
Expand Up @@ -624,7 +624,7 @@ So, as a solution, the littlefs adopted a sort of threaded tree. Each
directory not only contains pointers to all of its children, but also a
pointer to the next directory. These pointers create a linked-list that
is threaded through all of the directories in the filesystem. Because we
only use this linked list to check for existance, the order doesn't actually
only use this linked list to check for existence, the order doesn't actually
matter. As an added plus, we can repurpose the pointer for the individual
directory linked-lists and avoid using any additional space.

Expand Down
2 changes: 1 addition & 1 deletion tools/README.md
Expand Up @@ -22,7 +22,7 @@ Quick navigation:
| `importer` | code importer for use with CMSIS, TFM/PSA etc. |
| `libraries.py` | constants for building mbed 2 libraries |
| `make.py` | implementation of `mbed compile` |
| `memap.py` | map file parser and sumary generator |
| `memap.py` | map file parser and summary generator |
| `notifier` | API for seting compile status to a frontend |
| `options.py` | Default option parser and option utilities |
| `paths.py` | constants for many paths used |
Expand Down

0 comments on commit 331473a

Please sign in to comment.