Add a diagnostic to tell the user about the partition table format #397
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SergioGasquez
approved these changes
May 4, 2023
There was a problem hiding this comment.
LGTM! Just fyi, miette supports a url param under #[diagnostic], see https://github.com/zkat/miette#-diagnostic-code-urls
…en the image doesn't fit
MabezDev
force-pushed
the
diagnostic/link-to-partition-table-info
branch
from
d854cd3
to
d33e6a1
Compare
Thanks! I didn't know about that, I've updated the diagnostic to use the URL feature. |
SergioGasquez
approved these changes
May 4, 2023
Closed
jessebraham
reviewed
May 4, 2023
| @@ -44,6 +44,11 @@ pub enum Error { | |||
| #[error( | |||
| "Supplied ELF image of {0}B is too big, and doesn't fit configured app partition of {1}B" | |||
| )] | |||
| #[diagnostic( | |||
| code(espflash::image_too_big), | |||
| help("Reduce the size of the binary or increase the size of the partition."), | |||
There was a problem hiding this comment.
Would have preferred this to say "increase the size of the app partition", as it's pretty ambiguous now. Will fix it in another PR before release I guess.
MabezDev
added a commit
that referenced
this pull request
May 5, 2023
jessebraham
pushed a commit
that referenced
this pull request
May 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the image doesn't fit.