Skip to content

Commit bcb69d9

Browse files
cmaglieper1234
andauthored
[breaking] Removed real_name field from gRPC Library message and JSON responses (#1890)
* Removed real_name field from gRPC Library message * Update docs/UPGRADING.md Co-authored-by: per1234 <accounts@perglass.com> Co-authored-by: per1234 <accounts@perglass.com>
1 parent 1021e76 commit bcb69d9

File tree

5 files changed

+130
-133
lines changed

5 files changed

+130
-133
lines changed

arduino/libraries/libraries.go

-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,6 @@ func (library *Library) ToRPCLibrary() (*rpc.Library, error) {
132132
Location: library.Location.ToRPCLibraryLocation(),
133133
ContainerPlatform: platformOrEmpty(library.ContainerPlatform),
134134
Layout: library.Layout.ToRPCLibraryLayout(),
135-
RealName: library.Name,
136135
DotALinkage: library.DotALinkage,
137136
Precompiled: library.Precompiled,
138137
LdFlags: library.LDflags,

cli/lib/list.go

+1-4
Original file line numberDiff line numberDiff line change
@@ -129,10 +129,7 @@ func (ir installedResult) String() string {
129129
lastName := ""
130130
for _, libMeta := range ir.installedLibs {
131131
lib := libMeta.GetLibrary()
132-
name := lib.RealName
133-
if name == "" {
134-
name = lib.Name
135-
}
132+
name := lib.Name
136133
if name == lastName {
137134
name = ` "`
138135
} else {

docs/UPGRADING.md

+18
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,24 @@ freely renamed.
1919
This change improves the overall code base naming coherence since all the structures involving libraries have the `Name`
2020
field that refers to the library name as it appears in the `library.properties` file.
2121

22+
#### gRPC message `cc.arduino.cli.commands.v1.Library` no longer has `real_name` field
23+
24+
You must use the `name` field instead.
25+
26+
#### Machine readable `lib list` output no longer has "real name" field
27+
28+
##### JSON
29+
30+
The `[*].library.real_name` field has been removed.
31+
32+
You must use the `[*].library.name` field instead.
33+
34+
##### YAML
35+
36+
The `[*].library.realname` field has been removed.
37+
38+
You must use the `[*].library.name` field instead.
39+
2240
### `github.com/arduino/arduino-cli/arduino/libraries/librariesmanager.LibrariesManager.Install` removed parameter `installLocation`
2341

2442
The method:

0 commit comments

Comments
 (0)