tjh.dev
Clone of https://github.com/NixOS/nixpkgs.git (to stress-test knotserver)
Merge pull request #189111 from rapenne-s/zram_doc
zram module: rewording documentation to avoid misconception
authored by
Pascal Bach
and committed by
GitHub
e18ee6fb
ce735299
+5
-4
nixos/modules/config/zram.nix
+5
-4
nixos/modules/config/zram.nix
···
73
73
default = 50;
74
74
type = types.int;
75
75
description = lib.mdDoc ''
76
-
Maximum amount of memory that can be used by the zram swap devices
76
+
Maximum total amount of memory that can be stored in the zram swap devices
77
77
(as a percentage of your total memory). Defaults to 1/2 of your total
78
-
RAM. Run `zramctl` to check how good memory is
79
-
compressed.
78
+
RAM. Run `zramctl` to check how good memory is compressed.
79
+
This doesn't define how much memory will be used by the zram swap devices.
80
80
'';
81
81
};
82
82
···
84
84
default = null;
85
85
type = with types; nullOr int;
86
86
description = lib.mdDoc ''
87
-
Maximum total amount of memory (in bytes) that can be used by the zram
87
+
Maximum total amount of memory (in bytes) that can be stored in the zram
88
88
swap devices.
89
+
This doesn't define how much memory will be used by the zram swap devices.
89
90
'';
90
91
};
91
92