docs: Fix a few typos (#606)
* docs: Fix a few typos There are small typos in: - doc/versioning.md - src/components/ble/NimbleController.cpp - src/libs/mynewt-nimble/CODING_STANDARDS.md - src/libs/mynewt-nimble/docs/btshell/btshell_GAP.rst - src/systemtask/SystemTask.cpp Fixes: - Should read `milliseconds` rather than `miliseconds`. - Should read `unnecessary` rather than `uncesseray`. - Should read `target` rather than `tharget`. - Should read `project` rather than `projct`. - Should read `preferred` rather than `prefered`. - Should read `functioning` rather than `functionning`. - Should read `forever` rather than `forver`. - Should read `existing` rather than `exisiting`.
This commit is contained in:
parent
c9aeef94ea
commit
84a93b5441
|
@ -98,7 +98,7 @@ The script makes use of the following tools:
|
||||||
|
|
||||||
After setup you can use cmake as usual:
|
After setup you can use cmake as usual:
|
||||||
|
|
||||||
1. Generate the actual build files (out-of-source builds are strongly recomended):
|
1. Generate the actual build files (out-of-source builds are strongly recommended):
|
||||||
|
|
||||||
```commandline
|
```commandline
|
||||||
cmake -H. -B"cmake-build" -G "Unix Makefiles"
|
cmake -H. -B"cmake-build" -G "Unix Makefiles"
|
||||||
|
|
|
@ -3,4 +3,4 @@ The versioning of this project is based on [Semantic versionning](https://semver
|
||||||
|
|
||||||
- The **patch** is incremented when we fix a bug on a **released** version (most of the time using a **hotfix** branch).
|
- The **patch** is incremented when we fix a bug on a **released** version (most of the time using a **hotfix** branch).
|
||||||
- The **minor** is incremented when we release a new version with new features. It corresponds to a merge of **develop** into **master**.
|
- The **minor** is incremented when we release a new version with new features. It corresponds to a merge of **develop** into **master**.
|
||||||
- The **major** should be incremented when a breaking change is made to the application. We still have to define what is a breaking change in the context of this project. For now, I suggest that it stays **0** until we have a fully functionning firmware suited for the final user.
|
- The **major** should be incremented when a breaking change is made to the application. We still have to define what is a breaking change in the context of this project. For now, I suggest that it stays **0** until we have a fully functioning firmware suited for the final user.
|
|
@ -126,7 +126,7 @@ void NimbleController::StartAdvertising() {
|
||||||
// ASSERT(res == 0);// TODO I've disabled these ASSERT as they sometime asserts and reset the mcu.
|
// ASSERT(res == 0);// TODO I've disabled these ASSERT as they sometime asserts and reset the mcu.
|
||||||
// For now, the advertising is restarted as soon as it ends. There may be a race condition
|
// For now, the advertising is restarted as soon as it ends. There may be a race condition
|
||||||
// that prevent the advertising from restarting reliably.
|
// that prevent the advertising from restarting reliably.
|
||||||
// I remove the assert to prevent this uncesseray crash, but in the long term, the management of
|
// I remove the assert to prevent this unnecessary crash, but in the long term, the management of
|
||||||
// the advertising should be improve (better error handling, and advertise for 3 minutes after
|
// the advertising should be improve (better error handling, and advertise for 3 minutes after
|
||||||
// the application has been woken up, for example.
|
// the application has been woken up, for example.
|
||||||
}
|
}
|
||||||
|
|
|
@ -350,7 +350,7 @@ void SystemTask::Work() {
|
||||||
if (bleDiscoveryTimer == 0) {
|
if (bleDiscoveryTimer == 0) {
|
||||||
isBleDiscoveryTimerRunning = false;
|
isBleDiscoveryTimerRunning = false;
|
||||||
// Services discovery is deffered from 3 seconds to avoid the conflicts between the host communicating with the
|
// Services discovery is deffered from 3 seconds to avoid the conflicts between the host communicating with the
|
||||||
// tharget and vice-versa. I'm not sure if this is the right way to handle this...
|
// target and vice-versa. I'm not sure if this is the right way to handle this...
|
||||||
nimbleController.StartDiscovery();
|
nimbleController.StartDiscovery();
|
||||||
} else {
|
} else {
|
||||||
bleDiscoveryTimer--;
|
bleDiscoveryTimer--;
|
||||||
|
|
Loading…
Reference in New Issue
Block a user