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

Correction of extra GPIO pins needed for QIO SPI flash mode (ESPTOOL-972) #1041

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

michaesc
Copy link

@michaesc michaesc commented Dec 7, 2024

Bug fix

esptool-1040 (Github bug #1040

Testing

To test this correction please run the Sphynx documentation generator with the new (pull request) sources.

Copy link

github-actions bot commented Dec 7, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Make correction of QIO pins needed (HD GPIO12 and WP GPIO13) for QIO mode.":
    • summary should not end with a period (full stop)
    • 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 michaesc, 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 c8b56d1

@dobairoland dobairoland linked an issue Dec 7, 2024 that may be closed by this pull request
1 task
@github-actions github-actions bot changed the title Correction of extra GPIO pins needed for QIO SPI flash mode Correction of extra GPIO pins needed for QIO SPI flash mode (ESPTOOL-972) Dec 7, 2024
@radimkarnis
Copy link
Collaborator

Hello @michaesc,
thanks for contributing!

I believe your correction only applies to ESP32-C3, right? Currently, your commit will change the pin number in the docs for all the chips. The numbers should change depending on the currently selected chip target.

If you want to see how to do it, search for e.g. IDF_TARGET_BOOTLOADER_OFFSET on the same page.

Also, please change the commit name according to the message from the bot above. Adding docs(flash_modes): at the beginning should suffice.

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.

Docs state the wrong GPIO pins needed for QIO SPI flash mode (ESPTOOL-971)
2 participants