Proposed Edit to Minimize Future Upload Errors (ESPTOOL-879)

[JohnGF]

Based on community forums and personal experience, I propose an edit to the documentation/code to help minimize future errors during code uploads. This change aims to clarify that, in at least some implementations of the chip, it is necessary to hold the boot button until the connection is established when attempting to upload code or firmware.

I apologize if this change is deemed unnecessary, but I believe it will help prevent potential issues for users.

Thank you for considering this request.
Best regards,
João GF

This change fixes the following bug(s):

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

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

[github-actions]

Warnings

⚠️

Some issues found for the commit messages in this PR: the commit message "Just an attempt to clarify doc": body's lines must not be longer than 100 characters summary looks empty type/action looks empty Please fix these commit messages - here are some basic tips: follow Conventional Commits style correct format of commit message should be: <type/action>(<scope/component>): <summary>, 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).

👋 Hello JohnGF, 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 🚫 dangerJS against 445e0f0

[dobairoland]

Thank you for your pull request. I've left one suggestion.

Also please see the contribution guide and install the pre-commit hooks which will guide you to make commits in the required format.

[dobairoland]

This is not entirely true. It is not needed to enter Download mode, just to stay there if for some reason esptool's reset sequence on connection doesn't work.

I think we could add a note as the last item stating that this in practice means to hold the boot button or pull the boot pin down while starting esptool (with the default reset sequence) and keeping this until esptool establishes connection.