From 23264904d8b275ee00b7b6a724ca541ecf35e5e3 Mon Sep 17 00:00:00 2001 From: Solène Rapenne Date: Wed, 31 Aug 2022 15:15:02 +0200 Subject: zram module: rewording documentation to avoid misconception --- nixos/modules/config/zram.nix | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/nixos/modules/config/zram.nix b/nixos/modules/config/zram.nix index 34e80df47a4..ab73eb544a0 100644 --- a/nixos/modules/config/zram.nix +++ b/nixos/modules/config/zram.nix @@ -73,10 +73,10 @@ in default = 50; type = types.int; description = lib.mdDoc '' - Maximum amount of memory that can be used by the zram swap devices + Maximum total amount of memory that can be stored in the zram swap devices (as a percentage of your total memory). Defaults to 1/2 of your total - RAM. Run `zramctl` to check how good memory is - compressed. + RAM. Run `zramctl` to check how good memory is compressed. + This doesn't define how much memory will be used by the zram swap devices. ''; }; @@ -84,8 +84,9 @@ in default = null; type = with types; nullOr int; description = lib.mdDoc '' - Maximum total amount of memory (in bytes) that can be used by the zram + Maximum total amount of memory (in bytes) that can be stored in the zram swap devices. + This doesn't define how much memory will be used by the zram swap devices. ''; }; -- cgit 1.4.1