Add "permission denied" FAQ entry

arduino / arduino-cli

Arduino command line tool

https://arduino.github.io/arduino-cli/latest/

GNU General Public License v3.0

4.24k stars 370 forks source link

Add "permission denied" FAQ entry #2564

Closed wilyJ80 closed 3 months ago

wilyJ80 commented 3 months ago

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

CLAassistant commented 3 months ago

All committers have signed the CLA.

CLAassistant commented 3 months ago

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 commented 3 months ago

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 commented 3 months ago

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 commented 3 months ago

@wilyJ80 Thank you for opening this. I see that it was committed the compiled binary in https://github.com/arduino/arduino-cli/pull/2564/commits/b41effc1ffb637334b865012bd4db10ffe1e1cfa do you mind removing it?

wilyJ80 commented 3 months ago

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

alessio-perugini commented 3 months ago

@wilyJ80 Yup, thank you for bearing with us! :smile:

matthijskooijman commented 3 months ago

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 commented 3 months ago

@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 :pray: , I guess I have to change my :eyeglasses: