Skip to content

Commit 11914fa

Browse files
cmaglieper1234
andauthored
Apply suggestions from code review
Co-authored-by: per1234 <[email protected]>
1 parent a5cef06 commit 11914fa

4 files changed

+9
-9
lines changed

Diff for: docs/package_index_json-specification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Each tool describes a binary distribution of a command line tool. A tool can be:
8181
- a debugger
8282
- a program that performs a firmware upgrade
8383
- a [pluggable discovery](pluggable-discovery-specification.md)
84-
- a [pluggable monitor][pluggable-monitor-specification.md]
84+
- a [pluggable monitor](pluggable-monitor-specification.md)
8585

8686
basically anything that can run on the user's host PC and do something useful.
8787

Diff for: docs/platform-specification.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,7 @@ Monitor tools are a special kind of tool used to let the user communicate with t
762762
A platform must declare one or more Pluggable Monitor in its [`platform.txt`](#platformtxt) and bind them to a specific
763763
port protocol. Monitors can be referenced from other packages.
764764

765-
The following direcive is used to bind a specific monitor tool to a specific port protocol:
765+
The following directive is used to bind a specific monitor tool to a specific port protocol:
766766

767767
```
768768
pluggable_monitor.required.PROTOCOL=PLATFORM:MONITOR_NAME
@@ -794,7 +794,7 @@ example could be:
794794
pluggable_monitor.pattern.custom-ble="{runtime.tools.my-ble-monitor.path}/my-ble-monitor" -H
795795
```
796796

797-
in this case the platform provides a new hypotetical `custom-ble` protocol monitor tool and the command line tool named
797+
in this case the platform provides a new hypothetical `custom-ble` protocol monitor tool and the command line tool named
798798
`my-ble-monitor` is launched with the `-H` parameter to start the monitor tool. In this case the command line pattern
799799
may contain any extra parameter in the formula: this is different from the monitor tools installed through the
800800
`discoveryDependencies` field that must run without any command line parameter.

Diff for: docs/pluggable-discovery-specification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ the response to the command is:
4343
The `protocolVersion` field represents the protocol version that will be used in the rest of the communication. There
4444
are three possible cases:
4545

46-
- if the client/IDE supports the same or a more recent version of the protocol than the discovery, then the clietn/IDE
46+
- if the client/IDE supports the same or a more recent version of the protocol than the discovery, then the client/IDE
4747
should go into a compatibility mode and use the protocol level supported by the discovery.
4848
- if the discovery supports a more recent version of the protocol than the client/IDE: the discovery should downgrade
4949
itself into compatibility mode and report a `protocolVersion` that is less than or equal to the one supported by the

Diff for: docs/pluggable-monitor-specification.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The response to the command is:
128128
```JSON
129129
{
130130
"event": "configure",
131-
"message": "ok",
131+
"message": "ok"
132132
}
133133
```
134134

@@ -155,13 +155,13 @@ tool as part of the `OPEN` command. The syntax of the `OPEN` command is:
155155
`OPEN <CLIENT_TCPIP_ADDRESS> <BOARD_PORT>`
156156

157157
For example, let's suppose that the Client/IDE wants to communicate with the serial port `/dev/ttyACM0` using an
158-
hypotetical `serial-monitor` tool, then the sequence of actions to perform will be the following:
158+
hypothetical `serial-monitor` tool, then the sequence of actions to perform will be the following:
159159

160160
1. the Client/IDE must first listen to a random TCP port (let's suppose it chose `32123`)
161-
1. the Client/IDE runs the `serial-monitor` tool and initialize it with the `HELLO` command
161+
1. the Client/IDE runs the `serial-monitor` tool and initializes it with the `HELLO` command
162162
1. the Client/IDE sends the command `OPEN 127.0.0.1:32123 /dev/ttyACM0` to the monitor tool
163163
1. the monitor tool opens `/dev/ttyACM0`
164-
1. the monitor tool connects via TCP/IP to `127.0.0.1:32123` and start streaming data back and forth
164+
1. the monitor tool connects via TCP/IP to `127.0.0.1:32123` and starts streaming data back and forth
165165

166166
The answer to the `OPEN` command is:
167167

@@ -186,7 +186,7 @@ other error condition happens:
186186
The board port will be opened using the parameters previously set through the `CONFIGURE` command.
187187

188188
Once the port is opened, it may be unexpectedly closed at any time due to hardware failure, or because the Client/IDE
189-
closes the TCP/IP connection, etc. In this case an asynchronous `port_closed` message must be generated from the monitor
189+
closes the TCP/IP connection, etc. In this case an asynchronous `port_closed` message must be generated by the monitor
190190
tool:
191191

192192
```JSON

0 commit comments

Comments
 (0)