Skip to content

Commit 1885102

Browse files
committed
Renamed 'no-port' protocol to 'default'
1 parent 2e078d4 commit 1885102

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

RFCs/0002-pluggable-discovery.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -768,17 +768,17 @@ tools.arduino_ota.upload.pattern="{runtime.tools.arduinoOTA.path}/bin/arduinoOTA
768768
-sketch "{build.path}/{build.project_name}.bin"
769769
```
770770

771-
#### Support for upload "without a port" (`no-port` dummy protocol)
771+
#### Support for `default` fallback (allows upload "without a port")
772772

773773
Some upload tools already have the port detection builtin so there is no need to specify an upload port (for example the `openocd` tool is often able to autodetect the devices to upload by itself).
774774

775-
To support this particular use case a dummy `no-port` protocol has been reserved:
775+
To support this particular use case a dummy `default` protocol has been reserved:
776776

777777
```
778-
myboard.upload.tool.no-port=openocd_without_port
778+
myboard.upload.tool.default=openocd_without_port
779779
```
780780

781-
The `no-port` upload recipe will be selected when:
781+
The `default` upload protocol is a kind of wildcard-protocol, it will be selected when:
782782

783783
- The upload port is not specified
784784

@@ -789,21 +789,21 @@ or
789789
Let's see some examples to clarify:
790790

791791
```
792-
board1.upload.tool.no-port=openocd_without_port
792+
board1.upload.tool.default=openocd_without_port
793793
794794
board2.upload.tool.serial=bossac
795-
board2.upload.tool.no-port=openocd_without_port
795+
board2.upload.tool.default=openocd_without_port
796796
797797
board3.upload.tool.serial=bossac
798798
```
799799

800-
In the `board1` case: the `openocd_without_port` recipe will be always used, even if a port has been selected by the user.
800+
In the `board1` case: the `openocd_without_port` recipe will be always used, whatever the user's port selection.
801801

802-
In the `board2` case: the `bossac` recipe will be used if the port selected is a `serial` port, otherwise the `openocd_without_port` will be used in all other cases (even if a port has been selected by the user).
802+
In the `board2` case: the `bossac` recipe will be used if the port selected is a `serial` port, otherwise the `openocd_without_port` will be used in all other cases (whatever the user's port selection).
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 `no-port` upload, for example let's consider the Arduino Zero board:
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:
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 no-port PROT.
815+
arduino_zero_edbg.upload.tool=openocd <--- CONSIDERED AS default PROTOCOL
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,10 +821,10 @@ 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 `no-port` by default, in other words, it will be automatically converted into:
824+
in this case the upload definition will be always considered as a `default` protocol, in other words, it will be automatically converted into:
825825

826826
```
827-
arduino_zero_edbg.upload.no-port.tool=openocd
827+
arduino_zero_edbg.upload.default.tool=openocd
828828
```
829829

830830
## Open Questions

0 commit comments

Comments
 (0)