Unverified Commit 48dd5c77 authored by Cristian Maglie's avatar Cristian Maglie Committed by GitHub

Fixed '--libraries' and '--library' flags description in compile command (#1732)

* Fixed '--libraries' and '--library' flags description in compile command.

* Apply suggestions from code review
Co-authored-by: default avatarper1234 <accounts@perglass.com>
Co-authored-by: default avatarper1234 <accounts@perglass.com>
parent 652bcace
...@@ -116,9 +116,9 @@ func NewCommand() *cobra.Command { ...@@ -116,9 +116,9 @@ func NewCommand() *cobra.Command {
compileCommand.Flags().BoolVarP(&verify, "verify", "t", false, tr("Verify uploaded binary after the upload.")) compileCommand.Flags().BoolVarP(&verify, "verify", "t", false, tr("Verify uploaded binary after the upload."))
compileCommand.Flags().StringVar(&vidPid, "vid-pid", "", tr("When specified, VID/PID specific build properties are used, if board supports them.")) compileCommand.Flags().StringVar(&vidPid, "vid-pid", "", tr("When specified, VID/PID specific build properties are used, if board supports them."))
compileCommand.Flags().StringSliceVar(&library, "library", []string{}, compileCommand.Flags().StringSliceVar(&library, "library", []string{},
tr("List of paths to libraries root folders. Libraries set this way have top priority in case of conflicts. Can be used multiple times for different libraries.")) tr("Path to a single library’s root folder. Can be used multiple times or entries can be comma separated."))
compileCommand.Flags().StringSliceVar(&libraries, "libraries", []string{}, compileCommand.Flags().StringSliceVar(&libraries, "libraries", []string{},
tr("List of custom libraries dir paths separated by commas. Or can be used multiple times for multiple libraries dir paths.")) tr("Path to a collection of libraries. Can be used multiple times or entries can be comma separated."))
compileCommand.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, tr("Optional, optimize compile output for debugging, rather than for release.")) compileCommand.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, tr("Optional, optimize compile output for debugging, rather than for release."))
programmer.AddToCommand(compileCommand) programmer.AddToCommand(compileCommand)
compileCommand.Flags().BoolVar(&compilationDatabaseOnly, "only-compilation-database", false, tr("Just produce the compilation database, without actually compiling. All build commands are skipped except pre* hooks.")) compileCommand.Flags().BoolVar(&compilationDatabaseOnly, "only-compilation-database", false, tr("Just produce the compilation database, without actually compiling. All build commands are skipped except pre* hooks."))
......
// Code generated by protoc-gen-go-grpc. DO NOT EDIT. // Code generated by protoc-gen-go-grpc. DO NOT EDIT.
// versions:
// - protoc-gen-go-grpc v1.2.0
// - protoc v3.17.3
// source: cc/arduino/cli/commands/v1/commands.proto
package commands package commands
......
...@@ -74,7 +74,7 @@ type CompileRequest struct { ...@@ -74,7 +74,7 @@ type CompileRequest struct {
// If jobs is set to 0, it will use the number of available CPUs as the // If jobs is set to 0, it will use the number of available CPUs as the
// maximum. // maximum.
Jobs int32 `protobuf:"varint,14,opt,name=jobs,proto3" json:"jobs,omitempty"` Jobs int32 `protobuf:"varint,14,opt,name=jobs,proto3" json:"jobs,omitempty"`
// List of custom libraries dir paths. // A list of paths to directories containing a collection of libraries.
Libraries []string `protobuf:"bytes,15,rep,name=libraries,proto3" json:"libraries,omitempty"` Libraries []string `protobuf:"bytes,15,rep,name=libraries,proto3" json:"libraries,omitempty"`
// Optimize compile output for debug, not for release. // Optimize compile output for debug, not for release.
OptimizeForDebug bool `protobuf:"varint,16,opt,name=optimize_for_debug,json=optimizeForDebug,proto3" json:"optimize_for_debug,omitempty"` OptimizeForDebug bool `protobuf:"varint,16,opt,name=optimize_for_debug,json=optimizeForDebug,proto3" json:"optimize_for_debug,omitempty"`
...@@ -95,7 +95,7 @@ type CompileRequest struct { ...@@ -95,7 +95,7 @@ type CompileRequest struct {
// When set to `true` the compiled binary will be copied to the export // When set to `true` the compiled binary will be copied to the export
// directory. // directory.
ExportBinaries *wrapperspb.BoolValue `protobuf:"bytes,23,opt,name=export_binaries,json=exportBinaries,proto3" json:"export_binaries,omitempty"` ExportBinaries *wrapperspb.BoolValue `protobuf:"bytes,23,opt,name=export_binaries,json=exportBinaries,proto3" json:"export_binaries,omitempty"`
// List of paths to library root folders // A list of paths to single libraries root directory.
Library []string `protobuf:"bytes,24,rep,name=library,proto3" json:"library,omitempty"` Library []string `protobuf:"bytes,24,rep,name=library,proto3" json:"library,omitempty"`
// The path where to search for the custom signing key name and the encrypt // The path where to search for the custom signing key name and the encrypt
// key name // key name
......
...@@ -57,7 +57,7 @@ message CompileRequest { ...@@ -57,7 +57,7 @@ message CompileRequest {
// If jobs is set to 0, it will use the number of available CPUs as the // If jobs is set to 0, it will use the number of available CPUs as the
// maximum. // maximum.
int32 jobs = 14; int32 jobs = 14;
// List of custom libraries dir paths. // A list of paths to directories containing a collection of libraries.
repeated string libraries = 15; repeated string libraries = 15;
// Optimize compile output for debug, not for release. // Optimize compile output for debug, not for release.
bool optimize_for_debug = 16; bool optimize_for_debug = 16;
...@@ -78,7 +78,7 @@ message CompileRequest { ...@@ -78,7 +78,7 @@ message CompileRequest {
// When set to `true` the compiled binary will be copied to the export // When set to `true` the compiled binary will be copied to the export
// directory. // directory.
google.protobuf.BoolValue export_binaries = 23; google.protobuf.BoolValue export_binaries = 23;
// List of paths to library root folders // A list of paths to single libraries root directory.
repeated string library = 24; repeated string library = 24;
// The path where to search for the custom signing key name and the encrypt // The path where to search for the custom signing key name and the encrypt
// key name // key name
......
// Code generated by protoc-gen-go-grpc. DO NOT EDIT. // Code generated by protoc-gen-go-grpc. DO NOT EDIT.
// versions:
// - protoc-gen-go-grpc v1.2.0
// - protoc v3.17.3
// source: cc/arduino/cli/debug/v1/debug.proto
package debug package debug
......
// Code generated by protoc-gen-go-grpc. DO NOT EDIT. // Code generated by protoc-gen-go-grpc. DO NOT EDIT.
// versions:
// - protoc-gen-go-grpc v1.2.0
// - protoc v3.17.3
// cc/arduino/cli/monitor/v1/monitor.proto is a deprecated file.
package monitor package monitor
......
// Code generated by protoc-gen-go-grpc. DO NOT EDIT. // Code generated by protoc-gen-go-grpc. DO NOT EDIT.
// versions:
// - protoc-gen-go-grpc v1.2.0
// - protoc v3.17.3
// source: cc/arduino/cli/settings/v1/settings.proto
package settings package settings
......
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