Skip to content

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

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.

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
May 24, 2022

Conversation

cmaglie
Copy link
Member

@cmaglie cmaglie commented May 12, 2022

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • [] Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)

What kind of change does this PR introduce?
Fixed '--libraries' and '--library' flags description in compile command

What is the current behavior?
the description obtained from arduino-cli compile -h is:

      --libraries strings            List of custom libraries dir paths separated by commas. Or can be used multiple times for multiple libraries dir paths.
      --library strings              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.

and is wrong (well, at least is not very clear...)

  • What is the new behavior?
      --libraries strings            Path to a collection of libraries. Contained libraries override the ones found in the default libraries folder. Can be used multiple times or entries can be comma separated.
      --library strings              Path to a single library’s root folder. Overrides other occurrences of the library found in default libraries folder or passed in via --libraries. Can be used multiple times or entries can be comma separated.

Does this PR introduce a breaking change, and is titled accordingly?
No

@cmaglie cmaglie requested review from per1234 and ubidefeo May 12, 2022 15:10
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering whether it is wise to attempt an explanation of library priority here. Location is only one of the factors.

@cmaglie
Copy link
Member Author

cmaglie commented May 20, 2022

I'd rather keep the usage help short...

BTW your suggestion made me wonder if we could improve the verbose compilation output by indicating, in addition to which library it was selected, also why it was selected.

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may not have communicated clearly in my previous review. I was not suggesting that we should add to it. I was suggesting that we remove the incomplete information about library priority.

@cmaglie cmaglie force-pushed the fix_compile_flags_description branch from 11c968d to 698d302 Compare May 24, 2022 12:40
@cmaglie
Copy link
Member Author

cmaglie commented May 24, 2022

That makes sense. I've also changed the description of the gRPC API.

@per1234 per1234 added topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project labels May 24, 2022
@cmaglie cmaglie merged commit 48dd5c7 into arduino:master May 24, 2022
@cmaglie cmaglie deleted the fix_compile_flags_description branch May 24, 2022 13:12
@cmaglie cmaglie self-assigned this May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants