Skip to content

[breaking] Removed real_name field from gRPC Library message #1890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 4, 2022
+130 −133
Merged

[breaking] Removed real_name field from gRPC Library message #1890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e133de
Removed real_name field from gRPC Library message
cmaglie Sep 23, 2022
6c3e203
Update docs/UPGRADING.md
cmaglie Oct 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion arduino/libraries/libraries.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,6 @@ func (library *Library) ToRPCLibrary() (*rpc.Library, error) {
Location: library.Location.ToRPCLibraryLocation(),
ContainerPlatform: platformOrEmpty(library.ContainerPlatform),
Layout: library.Layout.ToRPCLibraryLayout(),
RealName: library.Name,
DotALinkage: library.DotALinkage,
Precompiled: library.Precompiled,
LdFlags: library.LDflags,
Expand Down
5 changes: 1 addition & 4 deletions cli/lib/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,7 @@ func (ir installedResult) String() string {
lastName := ""
for _, libMeta := range ir.installedLibs {
lib := libMeta.GetLibrary()
name := lib.RealName
if name == "" {
name = lib.Name
}
name := lib.Name
if name == lastName {
name = ` "`
} else {
Expand Down
18 changes: 18 additions & 0 deletions docs/UPGRADING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,24 @@ can be freely renamed.
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.

#### gRPC message `cc.arduino.cli.commands.v1.Library` no longer has `real_name` field

You must use the `name` field instead.

#### Machine readable `lib list` output no longer has "real name" field

##### JSON

The `[*].library.real_name` field has been removed.

You must use the `[*].library.name` field instead.

##### YAML

The `[*].library.realname` field has been removed.

You must use the `[*].library.name` field instead.

### `github.com/arduino/arduino-cli/arduino/libraries/librariesmanager.LibrariesManager.Install` removed parameter `installLocation`

The method:
Expand Down
Loading