git.iko.soy/typeable/nixpkgs
on master help sign in
Merge pull request #157259 from bb2020/mbpfan

nixos/mbpfan: update documentation

commit63f03d0888223512a583ea9788feac44a5483498 authorAaron Andersen <aaron@fosslib.net> dateSat 19 Feb 2022, 08:29 (5 years ago) parent694898ab25719b
1 file changed+14−8
nixos/modules/services/misc/mbpfan.nix+14−8
nixos/modules/services/misc/mbpfan.nix+14−8
@@ -6,7 +6,7 @@ let
66 cfg = config.services.mbpfan;
77 verbose = if cfg.verbose then "v" else "";
88 settingsFormat = pkgs.formats.ini {};
9− settingsFile = settingsFormat.generate "config.conf" cfg.settings;
9+ settingsFile = settingsFormat.generate "mbpfan.ini" cfg.settings;
1010
1111in {
1212 options.services.mbpfan = {
@@ -36,29 +36,35 @@ in {
3636 freeformType = settingsFormat.type;
3737
3838 options.general.min_fan1_speed = mkOption {
39− type = types.int;
39+ type = types.nullOr types.int;
4040 default = 2000;
41− description = "The minimum fan speed.";
41+ description = ''
42+ The minimum fan speed. Setting to null enables automatic detection.
43+ Check minimum fan limits with "cat /sys/devices/platform/applesmc.768/fan*_min".
44+ '';
4245 };
4346 options.general.max_fan1_speed = mkOption {
44− type = types.int;
47+ type = types.nullOr types.int;
4548 default = 6199;
46− description = "The maximum fan speed.";
49+ description = ''
50+ The maximum fan speed. Setting to null enables automatic detection.
51+ Check maximum fan limits with "cat /sys/devices/platform/applesmc.768/fan*_max".
52+ '';
4753 };
4854 options.general.low_temp = mkOption {
4955 type = types.int;
5056 default = 55;
51− description = "The low temperature.";
57+ description = "Temperature below which fan speed will be at minimum. Try ranges 55-63.";
5258 };
5359 options.general.high_temp = mkOption {
5460 type = types.int;
5561 default = 58;
56− description = "The high temperature.";
62+ description = "Fan will increase speed when higher than this temperature. Try ranges 58-66.";
5763 };
5864 options.general.max_temp = mkOption {
5965 type = types.int;
6066 default = 86;
61− description = "The maximum temperature.";
67+ description = "Fan will run at full speed above this temperature. Do not set it > 90.";
6268 };
6369 options.general.polling_interval = mkOption {
6470 type = types.int;