espressif / esptool

Espressif SoC serial bootloader utility
https://docs.espressif.com/projects/esptool
GNU General Public License v2.0
5.6k stars 1.39k forks source link

docs(flashing): Update error when connecting to serial port fails on linux (ESPTOOL-874) #984

Closed OrhanYigitDurmaz closed 3 months ago

OrhanYigitDurmaz commented 5 months ago

This pull request makes more description on linux based systems when esptool cant connect to the serial port defined by the user.

This change fixes the following bug(s):

I have tested this change with the following hardware & software combinations:

Tested on Arch, Ubuntu 22.04 and 20.04 and Windows 10

I have run the esptool.py automated integration tests with this change and the above hardware:

NO TESTING

github-actions[bot] commented 5 months ago
Warnings
:warning: **Some issues found for the commit messages in this PR:** - the commit message `"Update Permission denied error on linux systems"`: - *summary* looks empty - *type/action* looks empty *** **Please fix these commit messages** - here are some basic tips: - follow [Conventional Commits style](https://www.conventionalcommits.org/en/v1.0.0/) - correct format of commit message should be: `(): `, for example `fix(esp32): Fixed startup timeout issue` - allowed types are: `change,ci,docs,feat,fix,refactor,remove,revert,test` - sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter - avoid Jira references in commit messages (unavailable/irrelevant for our customers) `TIP:` Install pre-commit hooks and run this check when committing (uses the [Conventional Precommit Linter](https://github.com/espressif/conventional-precommit-linter)).

👋 Hello OrhanYigitDurmaz, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by :no_entry_sign: dangerJS against 824d0473db28c66bbf721cafdf71d152875aeeaf

radimkarnis commented 5 months ago

Hello @OrhanYigitDurmaz, thanks for the contribution, it is appreciated!

Adding more instructions is always welcome. In this case, we believe that instead of adding instructions for different Linux distros directly to the error message, we should go the opposite way - simplify the message and extend the Troubleshooting guide section in the docs instead. Would you be interested to move the information there?

Also, please take a look at the github-actions bot recommendations above this comment. The commit message is missing the type and scope.

Thanks!

OrhanYigitDurmaz commented 5 months ago

Hello @OrhanYigitDurmaz, thanks for the contribution, it is appreciated!

Adding more instructions is always welcome. In this case, we believe that instead of adding instructions for different Linux distros directly to the error message, we should go the opposite way - simplify the message and extend the Troubleshooting guide section in the docs instead. Would you be interested to move the information there?

Also, please take a look at the github-actions bot recommendations above this comment. The commit message is missing the type and scope.

Thanks!

You're right. Then giving the link to here is better. Maybe you could also add this to the troubleshooting section?

OrhanYigitDurmaz commented 5 months ago

Also looks like lint_esptool has some broken dependencies and thus, fails.

radimkarnis commented 4 months ago

You're right. Then giving the link to here is better. Maybe you could also add this to the troubleshooting section?

Do you want to finish the PR, or should we take over, then?

Also looks like lint_esptool has some broken dependencies and thus, fails.

That's unrelated to this PR, don't worry about the failure.