[skip changelog] Correct format of `upload_port` identification properties in snippet #2655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

per1234 merged 1 commit into arduino:master from per1234:correct-identification-properties

Jun 28, 2024

Merged

[skip changelog] Correct format of `upload_port` identification properties in snippet #2655

per1234 merged 1 commit into arduino:master from per1234:correct-identification-properties

Jun 28, 2024

Conversation

per1234

Copy link

Contributor

@per1234 per1234 commented Jun 28, 2024

Please check if the PR fulfills these requirements

See how to contribute

The PR has no duplicates (please search among the Pull Requests
before creating one)
The PR follows
our contributing guidelines
[NA] Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
[NA] UPGRADING.md has been updated with a migration guide (for breaking changes)
[NA] configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Docs fix

What is the current behavior?

The platform developer can associate port properties with a board definition in order to cause Arduino CLI to identify ports having those properties as that board.

The list format is supported for these platform properties in order to allow multiple alternative sets of port properties to be associated with a board definition. The platform property must have the format upload_port.n.<property ID> (where n is the array index of the port properties set).

Although the platform property format is correctly documented in the Arduino Platform Specification, an incorrect format upload_port.<property ID>.n was previously used in the boards.txt snippet illustrating the use of the platform properties.

What is the new behavior?

The snippet uses the correct property format.

Does this PR introduce a breaking change, and is titled accordingly?

No breaking change.

@per1234


 [skip changelog] Correct format of upload_port identification prope...

31814ba

...rties in snippet
The platform developer can associate port properties with a board definition in order to cause Arduino CLI to identify
ports having those properties as that board.
The list format is supported for these platform properties in order to allow multiple alternative port property sets to
be associated. The platform property must have the format `upload_port.n.<property ID>` (where "n" is the array index of
the port property set).
Although the platform property format is correctly documented in the Arduino Platform Specification, an incorrect format
`upload_port.<property ID>.n` was previously used in the boards.txt snippet illustrating the use of the platform
properties.