From 873ffb6b7db538fed3670852d38d1b174cb8d112 Mon Sep 17 00:00:00 2001
From: Filip Tibell <filip.tibell@gmail.com>
Date: Tue, 14 Mar 2023 10:50:34 +0100
Subject: [PATCH] Add note about aborting in release profile to Cargo.toml

---
 Cargo.toml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Cargo.toml b/Cargo.toml
index 0e677c8..f94f3ad 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -36,9 +36,15 @@ reqwest = { version = "0.11", default-features = false, features = [
 ] }
 
 # Profile for building the release binary, with the following options set:
+#
 # 1. Optimize for size
 # 2. Automatically strip symbols from the binary
 # 3. Enable link-time optimization
+#
+# Note that we could abort instead of panicking to cut down on size
+# even more, but because we use the filesystem & some other APIs we
+# need the panic unwinding to properly handle usage of said APIs
+#
 [profile.release]
 opt-level = "z"
 strip = true