Skip to content
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

Identical description of listall and search in arduino-cli board --help output #1720

Closed
jmnc2 opened this issue Apr 29, 2022 · 1 comment · Fixed by #2081
Closed

Identical description of listall and search in arduino-cli board --help output #1720

jmnc2 opened this issue Apr 29, 2022 · 1 comment · Fixed by #2081
Assignees
Labels
topic: CLI Related to the command line interface topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project

Comments

@jmnc2
Copy link

jmnc2 commented Apr 29, 2022

Bug Report

Current behavior

arduino-cli board

The help printed:
.
.
listall List all known boards and their corresponding FQBN.
search List all known boards and their corresponding FQBN.
.
.

But this is more about the getting-started guide.

Expected behavior

While following: https://arduino.github.io/arduino-cli/0.21/getting-started/
It says:

identify the platform core and use the correct FQBN string. When a board is 
not detected for whatever reason, you can list all the supported boards and
their FQBN strings by running the following:

$ arduino-cli board listall mkr

At least for me listall lists the boards that are installed, so just gives a blank list at this point.
After messing around and deleting the settings folder and redoing

$ arduino-cli config init
$ arduino-cli core update-index

still the same so after reading help from 'arduino-cli board' tried using: 'arduino-cli board search' instead and that worked.
Then after doing 'arduino-cli core install arduino:avr'
'arduino-cli board listall' now lists all the avr boards supported by arduino:avr

So I guess the documentation is wrong and search is what lists all the boards?
While listall lists the installed boards?

The help from 'arduino-cli board' could also use improving to make it clear what listall and search do.

Environment

  • CLI version (output of arduino-cli version):
  • OS and platform: Linux Manjaro

Additional context

@per1234
Copy link
Contributor

per1234 commented Apr 29, 2022

Thanks @jmnc2! We have an existing issue that is used to track the fact that it is not clear that board listall only lists boards of installed platforms: #550

I think this situation with the command line help produced by arduino-cli board --help having identical descriptions for both listall and search definitely needs to be fixed, so we can use this issue to track that problem.

@per1234 per1234 added topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project topic: CLI Related to the command line interface labels Apr 29, 2022
@per1234 per1234 changed the title Documentation board listall Identical description of listall and search in arduino-cli board --help output Apr 29, 2022
@per1234 per1234 self-assigned this Apr 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: CLI Related to the command line interface topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
3 participants