summary refs log tree commit diff
diff options
context:
space:
mode:
authorSolène Rapenne <solene.rapenne@tweag.io>2022-08-31 15:15:02 +0200
committerSolène Rapenne <solene.rapenne@tweag.io>2022-08-31 15:15:02 +0200
commit23264904d8b275ee00b7b6a724ca541ecf35e5e3 (patch)
tree9ac64481b64185a9d446da3ff2c053098387be7f
parentc476f232a6f31f446f8987c1e767c8ceee94b60f (diff)
downloadnixpkgs-23264904d8b275ee00b7b6a724ca541ecf35e5e3.tar
nixpkgs-23264904d8b275ee00b7b6a724ca541ecf35e5e3.tar.gz
nixpkgs-23264904d8b275ee00b7b6a724ca541ecf35e5e3.tar.bz2
nixpkgs-23264904d8b275ee00b7b6a724ca541ecf35e5e3.tar.lz
nixpkgs-23264904d8b275ee00b7b6a724ca541ecf35e5e3.tar.xz
nixpkgs-23264904d8b275ee00b7b6a724ca541ecf35e5e3.tar.zst
nixpkgs-23264904d8b275ee00b7b6a724ca541ecf35e5e3.zip
zram module: rewording documentation to avoid misconception
-rw-r--r--nixos/modules/config/zram.nix9
1 files 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.
         '';
       };