Skip to content

Commit 68e9f15

Browse files
committed
Made backward compatibility mode more explicit for default upload
1 parent 1885102 commit 68e9f15

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

Diff for: RFCs/0002-pluggable-discovery.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -803,7 +803,7 @@ In the `board2` case: the `bossac` recipe will be used if the port selected is a
803803

804804
In the `board3` case: the `bossac` recipe will be used if the port selected is a `serial` port, otherwise the upload will fail.
805805

806-
A lot of existing platforms already have recipes without an explicit port address, in this case the upload tool specified in the old (non-pluggable) way will be considered as a `default` protocol upload, for example let's consider the Arduino Zero board:
806+
A lot of legacy platforms already have recipes without an explicit port address, for example let's consider the Arduino Zero board:
807807

808808
```
809809
# Arduino Zero (Prorgamming Port)
@@ -812,7 +812,7 @@ arduino_zero_edbg.name=Arduino Zero (Programming Port)
812812
arduino_zero_edbg.vid.0=0x03eb
813813
arduino_zero_edbg.pid.0=0x2157
814814
815-
arduino_zero_edbg.upload.tool=openocd <--- CONSIDERED AS default PROTOCOL
815+
arduino_zero_edbg.upload.tool=openocd <---
816816
arduino_zero_edbg.upload.protocol=sam-ba
817817
arduino_zero_edbg.upload.maximum_size=262144
818818
arduino_zero_edbg.upload.maximum_data_size=32768
@@ -821,12 +821,14 @@ arduino_zero_edbg.upload.wait_for_upload_port=false
821821
arduino_zero_edbg.upload.native_usb=false
822822
```
823823

824-
in this case the upload definition will be always considered as a `default` protocol, in other words, it will be automatically converted into:
824+
in this case, to ensure backward compatibility, the upload tool specified in the old (non-pluggable) way will be considered as a `default` protocol upload, and it will be automatically converted into:
825825

826826
```
827827
arduino_zero_edbg.upload.default.tool=openocd
828828
```
829829

830+
Please note that the transformation above is intentended only as a backward compatiblity helper and it will be applied only on platforms that does not support Pluggable Discovery at all: if any other `*.upload.*.tool` or `discovery.*` definition is found in the platform, the transformation above will **not** be automatically applied.
831+
830832
## Open Questions
831833

832834
### CLI command line UX considerations

0 commit comments

Comments
 (0)