Skip to content

Refactor image format #877

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.

Sign up for GitHub

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

Jump to bottom
Merged
SergioGasquez merged 25 commits into from
Jun 12, 2025
Merged

Refactor image format #877

SergioGasquez merged 25 commits into from
Jun 12, 2025

Conversation

@SergioGasquez
Copy link
Member

@SergioGasquez SergioGasquez commented Jun 11, 2025 •
edited
Loading

Draft PR as there are still some missing parts:

  • We need to check if the provided EspIdfFormatArgs make sense for the selected subcommand
  • There are still some esp-idf specifics that are not in the esp-idf module, maybe we should move them
  • Not sure if I like the make_... methods, but I cant think of anything better
  • Not sure if some things should live in targets/<chip>.rs or as method of the Chip enum
    • This can/should be done in a later PR if required.
  • There are also some TODOs in the code that need to be resolved
  • Maybe there is some docstrings missing
  • There are still some ESP-IDF only annotations

Any feedback or suggestion is more than welcome!

@SergioGasquez SergioGasquez linked an issue Jun 11, 2025 that may be closed by this pull request
Refactor image formatting, and allow supporting new image formats in a backward compatible way #745
Closed
@SergioGasquez SergioGasquez mentioned this pull request Jun 11, 2025
Merged
MabezDev
MabezDev reviewed Jun 11, 2025
View reviewed changes
SergioGasquez
SergioGasquez commented Jun 12, 2025
View reviewed changes
SergioGasquez
SergioGasquez commented Jun 12, 2025
View reviewed changes
SergioGasquez
SergioGasquez commented Jun 12, 2025
View reviewed changes
@SergioGasquez SergioGasquez force-pushed the feat/imageformat branch 2 times, most recently from 85db5d2 to 446dc17 Compare June 12, 2025 09:30
MabezDev
MabezDev reviewed Jun 12, 2025
View reviewed changes
MabezDev
MabezDev requested changes Jun 12, 2025
View reviewed changes
Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

LGTM, awesome job! This was no easy feat :D.

Could you add the changelog now?

jessebraham and others added 18 commits June 12, 2025 13:04
@jessebraham @SergioGasquez
Begin making it possible to add additional image formats in the future
0f9ab78
@jessebraham @SergioGasquez
Add a method to return app image metadata, fix(?) size printing code
557566f
@jessebraham @SergioGasquez
Fix clippy warning
8287f46
@SergioGasquez
feat: Remove Esp32Params
aa64f89
@SergioGasquez
feat: Esp-idf only stuff
e679b78
@SergioGasquez
feat: Initial CLI changes
611bec4
@SergioGasquez
feat: Avoid code duplication
01f5b2f
@SergioGasquez
feat: Remove the option to pass partition name to write bin
f8f4ae4
@SergioGasquez
feat: Allow image format args in configuration
181261c
@SergioGasquez
feat: Reduce IdfBootloaderFormat arguments
fb2e5e5
@SergioGasquez
feat: Remove flash_image and rely on ImageFormat
ed336d8
@SergioGasquez
tests: Remove write-bin to a partition name test
4667f27
@SergioGasquez
style: Rename methods
8d42caf
@SergioGasquez
feat: Check erase-parts arguments
8566d8e
@SergioGasquez
docs: Remove todo
85bab69
@SergioGasquez
feat: Simplify parse_partition_table
d2cd394
@SergioGasquez
feat: Improve docstrings, rename bootloader method
01f07ee
@SergioGasquez
feat: Update visivility and create a getter for partition-table
b1c0c0c
@SergioGasquez
Copy link
Member Author

SergioGasquez commented Jun 12, 2025

Just rebased and added the changelog entry! Thanks @jessebraham and @MabezDev for all your work/help!

@SergioGasquez SergioGasquez requested a review from MabezDev June 12, 2025 11:14
MabezDev
MabezDev approved these changes Jun 12, 2025
View reviewed changes
Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

JurajSadel
JurajSadel reviewed Jun 12, 2025
View reviewed changes
JurajSadel
JurajSadel reviewed Jun 12, 2025
View reviewed changes
JurajSadel
JurajSadel approved these changes Jun 12, 2025
View reviewed changes
Copy link
Contributor

@JurajSadel JurajSadel left a comment

Choose a reason for hiding this comment

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

Thanks for working on this!

@MabezDev MabezDev enabled auto-merge June 12, 2025 11:38
@MabezDev MabezDev added this pull request to the merge queue Jun 12, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 12, 2025
@SergioGasquez SergioGasquez added this pull request to the merge queue Jun 12, 2025
Merged via the queue into esp-rs:main with commit 56a23a7 Jun 12, 2025
25 checks passed
@SergioGasquez SergioGasquez deleted the feat/imageformat branch June 12, 2025 12:13
@MabezDev MabezDev mentioned this pull request Jun 19, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MabezDev MabezDev MabezDev approved these changes

@JurajSadel JurajSadel JurajSadel approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Refactor image formatting, and allow supporting new image formats in a backward compatible way

4 participants

@SergioGasquez @MabezDev @JurajSadel @jessebraham