Skip to content

Conversation

@tyeth
Copy link

@tyeth tyeth commented Nov 11, 2025

Unchecked, but seems a sensible change.

@github-actions
Copy link

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Fix typo in firmware image format documentation":
    • 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).

⚠️ The Pull Request description looks very brief, please check if more details can be added.

👋 Hello tyeth, 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 888a148

@tyeth
Copy link
Author

tyeth commented Nov 11, 2025

There's also something weird in the next table, the three values are listed as '0xf', 0, 2 which might be another typo.
Feel free to close this and do a fresh commit with the correct title.

@github-actions github-actions bot changed the title Fix typo in firmware image format documentation Fix typo in firmware image format documentation (ESPTOOL-1205) Nov 11, 2025
| 3 | High four bits - Flash size (``0`` = 1MB, ``1`` = 2MB, ``2`` = 4MB, ``3`` = 8MB, ``4`` = 16MB) |
| | |
| | Low four bits - Flash frequency (``0`` = 80MHz, ``0`` = 40MHz, ``2`` = 20MHz) |
| | Low four bits - Flash frequency (``0`` = 80MHz, ``1`` = 40MHz, ``2`` = 20MHz) |
Copy link
Collaborator

@peterdragun peterdragun Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that this is correct and explained a couple of lines later, after the table in the note: Flash frequency with value ``0`` can mean either 80MHz or 40MHz based on MSPI clock source mode. Basically, there is a clock divider that will be set in ESP-IDF, which defines the final clock frequency.

Also, please note that these values correspond to ones in the code: https://github.com/espressif/esptool/blob/master/esptool/targets/esp32c6.py#L82-L86

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this could be improved in a way so it won't raise suspicion about being a mistake. For example:

``0`` = 80MHz or 40MHz

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah wonderful, thanks folks for the info and suggestion

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.

3 participants