Skip to content

Commit b2ead3e

Browse files
silvanocerzaper1234
andcommitted
Fix more documentation
Co-authored-by: per1234 <accounts@perglass.com>
1 parent 59f3ed4 commit b2ead3e

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

commands/upload/upload.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ func runProgramAction(pm *packagemanager.PackageManager,
444444
}
445445
}
446446

447-
// Get Port properties gathered using Pluggable Discovery
447+
// Get Port properties gathered using pluggable discovery
448448
uploadProperties.Set("upload.port.address", port.Address)
449449
uploadProperties.Set("upload.port.label", port.Label)
450450
uploadProperties.Set("upload.port.protocol", port.Protocol)

docs/UPGRADING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ message DetectedPort {
5757

5858
The properties previously contained directly in the message are now stored in the `port` property.
5959

60-
These changes are necessary for the Pluggable Discovery.
60+
These changes are necessary for the pluggable discovery.
6161

6262
### gRPC interface `BoardListItem` change
6363

docs/package_index_json-specification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Each tool describes a binary distribution of a command line tool. A tool can be:
8080
- a file preprocessor
8181
- a debugger
8282
- a program that performs a firmware upgrade
83-
- a [Pluggable Discovery](pluggable-discovery-specification.md)
83+
- a [pluggable discovery](pluggable-discovery-specification.md)
8484

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

docs/platform-specification.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,7 @@ The tool configuration properties are available globally without the prefix. For
644644
property can be used as **{cmd.path}** inside the recipe, and the same happens for all the other avrdude configuration
645645
variables.
646646

647-
#### Pluggable Discovery
647+
#### Pluggable discovery
648648

649649
Discovery tools are a special kind of tool used to find supported boards. A platform must declare one or more Pluggable
650650
Discoveries in its [`platform.txt`](#platformtxt). Discoveries can be referenced from other packages, including the
@@ -660,7 +660,7 @@ instead if it needs multiple discoveries:
660660
pluggable_discovery.required.1=VENDOR_ID:DISCOVERY_1_NAME
661661

662662
A platform that supports only boards connected via serial ports can easily use the `builtin` package's
663-
`serial-discovery` without creating a custom Pluggable Discovery:
663+
`serial-discovery` without creating a custom pluggable discovery:
664664

665665
pluggable_discovery.required=builtin:serial-discovery
666666

@@ -777,9 +777,9 @@ If necessary the same property can be defined multiple times for different proto
777777

778778
The two above properties will be available as **{upload.serial.maximum_size}** and **{upload.network.maximum_size}**.
779779

780-
#### Properties from Pluggable Discovery
780+
#### Properties from pluggable discovery
781781

782-
If a platform supports Pluggable Discovery it can also use the port's properties returned by a discovery. For example,
782+
If a platform supports pluggable discovery it can also use the port's properties returned by a discovery. For example,
783783
the following port metadata coming from a pluggable discovery:
784784

785785
{

docs/pluggable-discovery-specification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Discovery tools are a special kind of tool used to find supported boards, a platform developer can create its own
1+
Discovery tools are a special kind of tool used to find supported boards, a platform developer can create their own
22
following the specification below. These tools must be in the form of executables that can be launched as a subprocess
33
using a `platform.txt` command line recipe. They communicate to the parent process via stdin/stdout, accepting commands
44
as plain text strings from stdin and sending answers back in JSON format on stdout. Each tool will implement the

0 commit comments

Comments
 (0)