Skip to content

Commit 5c2d00d

Browse files
authored
Merge pull request #5 from facchinm/ci-spell-check
Add CI workflow to check for commonly misspelled words
2 parents 3b43f1e + 001eef4 commit 5c2d00d

File tree

10 files changed

+73
-6
lines changed

10 files changed

+73
-6
lines changed

.codespellrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
2+
# See: https://github.com/codespell-project/codespell#using-a-config-file
3+
[codespell]
4+
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
5+
ignore-words-list = freeed,
6+
skip = ./.git,./.licenses,__pycache__,node_modules,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock
7+
builtin = clear,informal,en-GB_to_en-US
8+
check-filenames =
9+
check-hidden =

.github/workflows/spell-check.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Spell Check
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
pull_request:
7+
schedule:
8+
# Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
9+
- cron: "0 8 * * TUE"
10+
workflow_dispatch:
11+
repository_dispatch:
12+
13+
jobs:
14+
spellcheck:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v3
20+
21+
- name: Spell check
22+
uses: codespell-project/actions-codespell@master

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
build
2+
.idea/

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<img src="https://content.arduino.cc/website/Arduino_logo_teal.svg" height="100" align="right" />
2+
3+
`USBHostMbed5`
4+
==============
5+
6+
[![Spell Check status](https://github.com/facchinm/USBHostMbed5/actions/workflows/spell-check.yml/badge.svg)](https://github.com/facchinm/USBHostMbed5/actions/workflows/spell-check.yml)
7+
8+
ARM Mbed5 USB Host library ported for [ArduinoCore-mbed](https://github.com/arduino/ArduinoCore-mbed) enabled boards.
9+
10+
## :mag_right: Resources
11+
12+
* [How to install a library](https://www.arduino.cc/en/guide/libraries)
13+
* [Help Center](https://support.arduino.cc/)
14+
* [Forum](https://forum.arduino.cc)
15+
16+
## :bug: Bugs & Issues
17+
18+
If you want to report an issue with this library, you can submit it to the [issue tracker](https://github.com/arduino-libraries/Arduino_Braccio_plusplus/issues) of this repository. Remember to include as much detail as you can about your hardware set-up, code and steps for reproducing the issue. Make sure you're using an original Arduino board.
19+
20+
## :technologist: Development
21+
22+
There are many ways to contribute:
23+
24+
* Improve documentation and examples
25+
* Fix a bug
26+
* Test open Pull Requests
27+
* Implement a new feature
28+
* Discuss potential ways to improve this library
29+
30+
You can submit your patches directly to this repository as Pull Requests. Please provide a detailed description of the problem you're trying to solve and make sure you test on real hardware.
31+
32+
## :yellow_heart: Donations
33+
34+
This open-source code is maintained by Arduino with the help of the community. We invest a considerable amount of time in testing code, optimizing it and introducing new features. Please consider [donating](https://www.arduino.cc/en/donate/) or [sponsoring](https://github.com/sponsors/arduino) to support our work, as well as [buying original Arduino boards](https://store.arduino.cc/) which is the best way to make sure our effort can continue in the long term.
35+

src/USBHost/USBDeviceConnected.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class USBDeviceConnected
5252
* Attach an USBEndpoint to this device
5353
*
5454
* @param intf_nb interface number
55-
* @param ep pointeur on the USBEndpoint which will be attached
55+
* @param ep pointer on the USBEndpoint which will be attached
5656
* @returns true if successful, false otherwise
5757
*/
5858
bool addEndpoint(uint8_t intf_nb, USBEndpoint * ep);

src/USBHost/USBEndpoint.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ class USBEndpoint
107107
}
108108

109109
/**
110-
* Call the handler associted to the end of a transfer
110+
* Call the handler associated to the end of a transfer
111111
*/
112112
inline void call() {
113113
if (rx)

src/USBHost/USBHost.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ class USBHost : public USBHALHost {
132132
/**
133133
* reset a specific device
134134
*
135-
* @param dev device which will be resetted
135+
* @param dev device which will be reset
136136
*/
137137
USB_TYPE resetDevice(USBDeviceConnected * dev);
138138

src/USBHost/USBHostTypes.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ typedef struct hcTd {
188188
typedef struct hcEd {
189189
__IO uint32_t control; // Endpoint descriptor control
190190
__IO HCTD * tailTD; // Physical address of tail in Transfer descriptor list
191-
__IO HCTD * headTD; // Physcial address of head in Transfer descriptor list
191+
__IO HCTD * headTD; // Physical address of head in Transfer descriptor list
192192
__IO hcEd * nextED; // Physical address of next Endpoint descriptor
193193
} PACKED HCED;
194194
// ----------- Host Controller Communication Area ------------

src/USBHostMSD/USBHostMSD.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ int USBHostMSD::SCSITransfer(uint8_t * cmd, uint8_t cmd_len, int flags, uint8_t
273273
BO_MASS_STORAGE_RESET,
274274
0, msd_intf, NULL, 0);
275275

276-
// unstall both endpoints
276+
// uninstall both endpoints
277277
res = host->controlWrite( dev,
278278
USB_RECIPIENT_ENDPOINT | USB_HOST_TO_DEVICE | USB_REQUEST_TYPE_STANDARD,
279279
CLEAR_FEATURE,

src/targets/TARGET_STM/USBHALHost_STM.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd, uint8_t chnum,
128128
}
129129
}
130130
if ((type == EP_TYPE_INTR)) {
131-
/* reply a packet of length NULL, this will be analyse in call back
131+
/* reply a packet of length NULL, this will be analyze in call back
132132
* for mouse or hub */
133133
td->state = USB_TYPE_IDLE ;
134134
HAL_HCD_DisableInt(hhcd, chnum);

0 commit comments

Comments
 (0)