You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/UPGRADING.md
+46
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,52 @@ Here you can find a list of migration guides to handle breaking changes between
4
4
5
5
## 0.28.0
6
6
7
+
### Breaking changes in libraries name handling
8
+
9
+
In the structure `github.com/arduino/arduino-cli/arduino/libraries.Library` the field:
10
+
*`RealName` has been renamed to `Name`
11
+
*`Name` has been renamed to `CanonicalName`
12
+
13
+
Now `Name` is the name of the library as it appears in the `library.properties` file and `CanonicalName` it's the name of the directory containing the library. The `CanonicalName` is usually the name of the library with non-alphanumeric characters converted to underscore, but it could be actually anything since the directory where the library is installed can be freely renamed.
14
+
15
+
This change improves the overall code base naming coherence since all the structures involving libraries have the `Name` field that refers to the library name as it appears in the `library.properties` file.
0 commit comments