Add a diagnostic to tell the user about the partition table format wh…

…en the image doesn't fit (#397)
esp-rs · May 4, 2023 · 6d52193 · 6d52193
1 parent b50f90a
commit 6d52193
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/espflash/src/error.rs b/espflash/src/error.rs
@@ -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."),
+        url("https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/partition-tables.html#built-in-partition-tables")
+    )]
     ElfTooBig(u32, u32),
 
     #[error("Failed to connect to on-device flash")]