Unverified Commit bcb69d99 authored by Cristian Maglie's avatar Cristian Maglie Committed by GitHub

[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: default avatarper1234 <accounts@perglass.com>
Co-authored-by: default avatarper1234 <accounts@perglass.com>
parent 1021e76f
...@@ -132,7 +132,6 @@ func (library *Library) ToRPCLibrary() (*rpc.Library, error) { ...@@ -132,7 +132,6 @@ func (library *Library) ToRPCLibrary() (*rpc.Library, error) {
Location: library.Location.ToRPCLibraryLocation(), Location: library.Location.ToRPCLibraryLocation(),
ContainerPlatform: platformOrEmpty(library.ContainerPlatform), ContainerPlatform: platformOrEmpty(library.ContainerPlatform),
Layout: library.Layout.ToRPCLibraryLayout(), Layout: library.Layout.ToRPCLibraryLayout(),
RealName: library.Name,
DotALinkage: library.DotALinkage, DotALinkage: library.DotALinkage,
Precompiled: library.Precompiled, Precompiled: library.Precompiled,
LdFlags: library.LDflags, LdFlags: library.LDflags,
......
...@@ -129,10 +129,7 @@ func (ir installedResult) String() string { ...@@ -129,10 +129,7 @@ func (ir installedResult) String() string {
lastName := "" lastName := ""
for _, libMeta := range ir.installedLibs { for _, libMeta := range ir.installedLibs {
lib := libMeta.GetLibrary() lib := libMeta.GetLibrary()
name := lib.RealName name := lib.Name
if name == "" {
name = lib.Name
}
if name == lastName { if name == lastName {
name = ` "` name = ` "`
} else { } else {
......
...@@ -19,6 +19,24 @@ freely renamed. ...@@ -19,6 +19,24 @@ freely renamed.
This change improves the overall code base naming coherence since all the structures involving libraries have the `Name` 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. 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` ### `github.com/arduino/arduino-cli/arduino/libraries/librariesmanager.LibrariesManager.Install` removed parameter `installLocation`
The method: The method:
......
This diff is collapsed.
...@@ -250,7 +250,7 @@ message InstalledLibrary { ...@@ -250,7 +250,7 @@ message InstalledLibrary {
} }
message Library { message Library {
// The library's directory name. // Library name (value of `name` field in library.properties).
string name = 1; string name = 1;
// Value of the `author` field in library.properties. // Value of the `author` field in library.properties.
string author = 2; string author = 2;
...@@ -279,8 +279,6 @@ message Library { ...@@ -279,8 +279,6 @@ message Library {
// identifying string for the platform containing the library // identifying string for the platform containing the library
// (e.g., `arduino:avr@1.8.2`). // (e.g., `arduino:avr@1.8.2`).
string container_platform = 14; string container_platform = 14;
// Value of the `name` field in library.properties.
string real_name = 16 [ deprecated = true ];
// Value of the `dot_a_linkage` field in library.properties. // Value of the `dot_a_linkage` field in library.properties.
bool dot_a_linkage = 17; bool dot_a_linkage = 17;
// Value of the `precompiled` field in library.properties. // Value of the `precompiled` field in library.properties.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment