From 9168cc5999d87f0c27a7b4a93c28bf1f0baaf369 Mon Sep 17 00:00:00 2001 From: dankeboy36 Date: Fri, 21 Nov 2025 14:53:52 +0100 Subject: [PATCH 1/2] fix(doc): clarify profile port protocol usage Ref: arduino/arduino-cli#2717 Signed-off-by: dankeboy36 --- docs/sketch-project-file.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sketch-project-file.md b/docs/sketch-project-file.md index 661a6a4398f..80070b75ec2 100644 --- a/docs/sketch-project-file.md +++ b/docs/sketch-project-file.md @@ -71,7 +71,9 @@ The following fields are available since Arduino CLI 1.1.0: - `port_config` section with `` and `` defines the port settings that will be used in the `monitor` command. Typically is used to set the baudrate for the serial port (for example `baudrate: 115200`) but any setting/value can be specified. Multiple settings can be set. These fields are optional. -- `` is the protocol for the port used to upload and monitor the board. This field is optional. +- `` is the protocol for the port used to upload and monitor the board. Arduino CLI ignores this value at + runtime, so write it only if an external client (for example one using the gRPC [`Port`](/rpc/commands/#port)) needs to restore the `protocol` together with the port `address`. Clients that do not set it should assume their + own default (usually `serial`). This field is optional. #### Using a system-installed platform. From 73878ce81d0cce85596eaecefdd8f4eee3f5de6f Mon Sep 17 00:00:00 2001 From: dankeboy36 Date: Fri, 21 Nov 2025 15:05:23 +0100 Subject: [PATCH 2/2] fix(lint): :lipstick: Signed-off-by: dankeboy36 --- docs/sketch-project-file.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/sketch-project-file.md b/docs/sketch-project-file.md index 80070b75ec2..b5b6d0ebb47 100644 --- a/docs/sketch-project-file.md +++ b/docs/sketch-project-file.md @@ -72,8 +72,9 @@ The following fields are available since Arduino CLI 1.1.0: used in the `monitor` command. Typically is used to set the baudrate for the serial port (for example `baudrate: 115200`) but any setting/value can be specified. Multiple settings can be set. These fields are optional. - `` is the protocol for the port used to upload and monitor the board. Arduino CLI ignores this value at - runtime, so write it only if an external client (for example one using the gRPC [`Port`](/rpc/commands/#port)) needs to restore the `protocol` together with the port `address`. Clients that do not set it should assume their - own default (usually `serial`). This field is optional. + runtime, so write it only if an external client (for example one using the gRPC [`Port`](/rpc/commands/#port)) needs + to restore the `protocol` together with the port `address`. Clients that do not set it should assume their own default + (usually `serial`). This field is optional. #### Using a system-installed platform.