Skip to content

Commit 6a28502

Browse files
Update sketch name specifications in docs
1 parent cff586d commit 6a28502

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

Diff for: docs/UPGRADING.md

+9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Here you can find a list of migration guides to handle breaking changes between releases of the CLI.
44

5+
## 0.34.0
6+
7+
### Updated sketch name specifications
8+
9+
[Sketch name specifications](https://arduino.github.io/arduino-cli/dev/sketch-specification) have been updated to
10+
achieve cross-platform compatibility.
11+
12+
Existing sketch names violating the new constraint need to be updated.
13+
514
## 0.33.0
615

716
### gRPC `cc.arduino.cli.commands.v1.Compile` command now return expanded build_properties by default.

Diff for: docs/sketch-specification.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ The programs that run on Arduino boards are called "sketches". This term was inh
77

88
The sketch root folder name and code file names must start with a basic letter (`A`-`Z` or `a`-`z`), number (`0`-`9`)
99
[<sup>1</sup>](#leading-number-note), or underscore (`_`) [<sup>2</sup>](#leading-underscore-note) followed by basic
10-
letters, numbers, underscores, dots (`.`) and dashes (`-`). The maximum length is 63 characters.
10+
letters, numbers, underscores, dots (`.`) and dashes (`-`). The maximum length is 63 characters. The sketch name cannot
11+
end with a dot (`.`) and cannot be a
12+
[reserved name](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions).
1113

1214
<a id="leading-number-note"></a> <sup>1</sup> Supported from Arduino IDE 1.8.4. <br />
1315
<a id="leading-underscore-note"></a> <sup>2</sup> Supported in all versions except Arduino IDE 2.0.4/Arduino CLI

0 commit comments

Comments
 (0)