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

Add "permission denied" FAQ entry #2564

Merged
merged 5 commits into from
Mar 18, 2024
Merged

Conversation

wilyJ80
Copy link
Contributor

@wilyJ80 wilyJ80 commented Mar 10, 2024

Given the 50+ results for this "permission denied" error when uploading a sketch to the board in the forum, this entry was added to the FAQ. This might be desirable to have in an easily accessible page given it's a necessary step to take to get started with the microcontroller.

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?

What is the current behavior?

What is the new behavior?

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

Other information

Given the 50+ results for this "permission denied" error when uploading a sketch to the board in the forum, this entry was added to the FAQ. This might be desirable to have in an easily accessible page given it's a necessary step to take to get started with the microcontroller.
@CLAassistant
Copy link

CLAassistant commented Mar 10, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@matthijskooijman
Copy link
Collaborator

Looks good to document this. I would suggest:

  • Making it a bit clearer that this works on Linux
  • Clarify that this command works on most Linux distributions, but the exact command (group name) might be different on differnet distros (maybe also add an ls -l /dev/ttyACM0 command or so to help people figure out the command they need.
  • Maybe adding a command id | grep dialout or cat /dev/ttyACM0 they can use to verify if this is actually the problem and this fix is appropriate.

I realize that adding all these things might result in hairy and hard-to-read FAQ entry, so maybe not everything should be added (or maybe you can find a wording and structure that balances readability and completeness...).

@wilyJ80
Copy link
Contributor Author

wilyJ80 commented Mar 14, 2024

Pushed some changes. Tried to keep things concise but still reliable as suggested. Thanks for the suggestions, I'm learning more and more about the software side of Arduino.

@alessio-perugini
Copy link
Contributor

@wilyJ80 Thank you for opening this. I see that it was committed the compiled binary in b41effc do you mind removing it?

@wilyJ80
Copy link
Contributor Author

wilyJ80 commented Mar 18, 2024

Removed the binary directory. Is it OK now? Thank you for the patience. I'm starting out with contributing with this community. 😄

@alessio-perugini alessio-perugini merged commit 6a45713 into arduino:master Mar 18, 2024
6 checks passed
@alessio-perugini
Copy link
Contributor

@wilyJ80 Yup, thank you for bearing with us! 😄

@matthijskooijman
Copy link
Collaborator

Hm, I'm a bit late to the party, but the documentation now just says "your group name", without any reference to how to figure out this group name, which is probably not very actionable for most users. I would suggest to use dialout in the example commandline and then say something like "The group name must be the owning group of the serial port (e.g. /dev/ttyACM0), on most Linux distributions it is dialout"

@alessio-perugini
Copy link
Contributor

alessio-perugini commented Mar 18, 2024

@matthijskooijman Oops, I missed that it was later changed into <group> somehow I managed to still read it with dialout.
@wilyJ80 if you don't mind I'd open a quick PR adding the suggestion of @matthijskooijman .
Sorry about that 🙏 , I guess I have to change my 👓

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants