Skip to content

Docs incorrectly state that upload will treat -P list as an instruction to list programmers #967

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

Closed
PeterWone opened this issue Sep 23, 2020 · 4 comments
Labels
topic: documentation Related to documentation for the project

Comments

@PeterWone
Copy link

Bug Report

Current behavior

arduino-cli upload --fqbn arduino:avr:nano --programmer list

Fails to treat list as a special symbol.

Expected behavior

The documentation says it will list available programmers.

Environment

  • CLI version (output of arduino-cli version): 0.13.0
  • OS and platform: Windows 10

Additional context

arduino-cli burn-bootloader --fqbn arduino:avr:nano --programmer list works as advertised.

The capability to get a list of supported programmers is available from burn-bootloader, perhaps update the documentation to suggest that.

@ubidefeo
Copy link

hi @PeterWone
because this syntax was pretty cumbersome and programmers are part of platform definition and related to a specific board, we introduced a new flag for boards detail to just show programmers

arduino-cli board details -b arduino:avr:uno --list-programmers

the fact that burn-bootloader still has that is a leftover that we'll have to cleanup :) (@silvanocerza )

@PeterWone
Copy link
Author

In that case this issue is actually about the docs being behind the reality. Thanks for sharing the reality!

@PeterWone PeterWone changed the title upload does not treat -P list as an instruction to list programmers Docs incorrectly state that upload will treat -P list as an instruction to list programmers Sep 24, 2020
@ubidefeo
Copy link

hey @PeterWone
you are right, we need to update the documentation.
Than you for pointing it out, some things end up slipping through the cracks :)

@per1234
Copy link
Contributor

per1234 commented Oct 22, 2020

The documentation has now been corrected by #982.

Thanks PeterWone!

@per1234 per1234 closed this as completed Oct 22, 2020
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
Projects
None yet
Development

No branches or pull requests

3 participants