dev: Add development infos

its-laika · Feb 1, 2025 · b0e7233 · b0e7233
1 parent ea69500
commit b0e7233
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ Heavily wip and not feature complete
 - [ ] Clean up code
 - [ ] Tests
 - [ ] Documentation
+- [ ] Memory usage is pretty high. I believe flushing the files affects this and leads to memory peaks. Fix that.
 
 ## License
 MIT
diff --git a/treasure_chest/development/.gitignore b/treasure_chest/development/.gitignore
@@ -0,0 +1 @@
+TESTFILE
diff --git a/treasure_chest/development/ALLOCATION.md b/treasure_chest/development/ALLOCATION.md
@@ -0,0 +1,13 @@
+# Debug memory allocation
+
+## Build test file
+- 100 MB file: `if=/dev/random of=TESTFILE status=progress bs=1m count=100`
+
+## Steps
+
+1. `cargo install --features vendored-openssl cargo-instruments`  
+  Installs _cargo-instruments_ without needing OpenSSL (macOS shenanigans -.-)
+2. `cargo instruments -t Allocations (--release)`
+3. Find PID
+4. `kill -SIGINT [PID]` to stop gracefully without interrupting cargo-instruments.
+5. XCode instrument _Allocations_ opens up automatically