Updated and refined documentation by cmaglie · Pull Request #2760 · arduino/arduino-cli (original) (raw)

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 andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation10 Commits7 Checks5 Files changed

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

Please check if the PR fulfills these requirements

See how to contribute

• 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)
• configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

• Refined platform specification on installation folder for platforms
• Expanded docs on default directories configuration
• Cleared usage of identification properties

What is the current behavior?

What is the new behavior?

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

Other information

Fix #2753

Co-authored-by: Alessio Perugini alessio@perugini.xyz

I also noticed that if I install a platform manually in {directories.user}/hardware/STMicroelectronics/stm32/..., while already having a installation via the Board Manager in {directories.data}/packages/STMicroelectronics/hardware/stm32/2.8.1/..., the one in the user directory takes precedence for what is seen in the Arduino IDE.

Example:

The problem is however, that I had a new version in {directories.user}/hardware/STMicroelectronics/stm32/... with new board variants, but I could not see those in the Board part number: ... menu as expected.

Is this a separate bug? In that it is possible to install a platform manually, and it is seen in the menu, but the actual new additions to the manual installation are not shown?

Also it might be good to mention in these docs what happens if you have the same VENDOR_NAME and ARCHITECTURE in these data and user directory?

Is this a separate bug? In that it is possible to install a platform manually, and it is seen in the menu, but the actual new additions to the manual installation are not shown?

Currently, if there are two matching platforms the one installed in the sketchbook should take precedence... but since you're not able to see the new board definitions there could be a regression, I'll check this out.
To avoid confusion, during the development of a platform, we use the "trick" to slightly rename the vendor installed in the sketchbook so instead of:

{directories.user}/hardware/STMicroelectronics/stm32/...

we use for example:

{directories.user}/hardware/STMicroelectronics-dev/stm32/...

This way there is no confusion and both platforms (the original and the "dev") are visible in the IDE.

Also it might be good to mention in these docs what happens if you have the same VENDOR_NAME and ARCHITECTURE in these data and user directory?

Yes good point.

This way there is no confusion and both platforms (the original and the "dev") are visible in the IDE.

This was not the case for me. I only saw the one as you see in the picture above.

Choose a reason for hiding this comment

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

LGTM (except I saw no mention of what happens there are matching VENDOR+ARCHITECTURE namings in the data and user directory.

except I saw no mention of what happens there are matching VENDOR+ARCHITECTURE namings in the data and user directory

I checked, and the Arduino CLI has a bug/regression. The expected behavior is not happening (the platform installed in the sketchbook should take priority over the one installed via Board Manager if they match VENDOR+ARCHITECTURE).

I'm going to open a new issue about this, I'll add the note in the documentation after the bug is fixed.
In the meantime, I'm merging this one.

Labels