From c05b0af7bbc00763c928cdee79719604a0f18f44 Mon Sep 17 00:00:00 2001
From: Adam Matthews <52178922+adamsthws@users.noreply.github.com>
Date: Sun, 9 Jun 2024 15:42:58 +0100
Subject: [PATCH] Update log2ram.conf

Update to comment for setting: 'LOG_DISK_SIZE='
---
 log2ram.conf | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/log2ram.conf b/log2ram.conf
index 79b9459..4354e55 100644
--- a/log2ram.conf
+++ b/log2ram.conf
@@ -57,8 +57,13 @@ ZL2R=false
 # Set COMP_ALG to 'lz4' for speed, 'zstd' for better compression, or 'lzo' or 'zlib' if optimizations or availability are concerns.
 COMP_ALG=lz4
 
-# LOG_DISK_SIZE is the uncompressed disk size. Note zram uses about 0.1% of the size of the disk when not in use
-# LOG_DISK_SIZE is expected compression ratio of alg chosen multiplied by log SIZE
-# lzo/lz4=2.1:1 compression ratio zlib=2.7:1 zstandard=2.9:1
-# Really a guestimate of a bit bigger than compression ratio whilst minimising 0.1% mem usage of disk size
+# LOG_DISK_SIZE specifies the uncompressed zram disk size. 
+# (Sets the size of the zram disk that will be presented to the operating system).
+# To estimate amount of RAM this will consume, divide LOG_DISK_SIZE by your chosen compression algorithm's ratio:
+# - lzo/lz4 typically compresses at a ratio of 2.1:1
+# - zlib compresses at about 2.7:1
+# - zstandard (zstd) achieves around 2.9:1
+# Example calculation using lz4:
+#    Given LOG_DISK_SIZE = 256M (which represents 256 Megabytes of uncompressed log data),
+#    the estimated zram RAM usage = 256 MB / 2.1 ≈ 122 MB of RAM.
 LOG_DISK_SIZE=256M