nixos/modules/rename.nix

   1 { lib, pkgs, ... }:
   2
   3 let
   4   inherit (lib)
   5     mkAliasOptionModuleMD
   6     mkRemovedOptionModule;
   7 in
   8 {
   9   imports = [
  10     /*
  11     This file defines some renaming/removing options for backwards compatibility
  12
  13     It should ONLY be used when the relevant module can't define these imports
  14     itself, such as when the module was removed completely.
  15     See https://github.com/NixOS/nixpkgs/pull/61570 for explanation
  16     */
  17
  18     # This alias module can't be where _module.check is defined because it would
  19     # be added to submodules as well there
  20     (mkAliasOptionModuleMD [ "environment" "checkConfigurationOptions" ] [ "_module" "check" ])
  21
  22     # Completely removed modules
  23     (mkRemovedOptionModule [ "environment" "blcr" "enable" ] "The BLCR module has been removed")
  24     (mkRemovedOptionModule [ "fonts" "fontconfig" "penultimate" ] "The corresponding package has removed from nixpkgs.")
  25     (mkRemovedOptionModule [ "hardware" "brightnessctl" ] ''
  26       The brightnessctl module was removed because newer versions of
  27       brightnessctl don't require the udev rules anymore (they can use the
  28       systemd-logind API). Instead of using the module you can now
  29       simply add the brightnessctl package to environment.systemPackages.
  30     '')
  31     (mkRemovedOptionModule [ "hardware" "u2f" ] ''
  32       The U2F modules module was removed, as all it did was adding the
  33       udev rules from libu2f-host to the system. Udev gained native support
  34       to handle FIDO security tokens, so this isn't necessary anymore.
  35     '')
  36     (mkRemovedOptionModule [ "hardware" "xow" ] ''
  37       The xow package was removed from nixpkgs. Upstream has deprecated
  38       the project and users are urged to switch to xone.
  39     '')
  40     (mkRemovedOptionModule [ "networking" "vpnc" ] "Use environment.etc.\"vpnc/service.conf\" instead.")
  41     (mkRemovedOptionModule [ "networking" "wicd" ] "The corresponding package was removed from nixpkgs.")
  42     (mkRemovedOptionModule [ "programs" "gnome-documents" ] "The corresponding package was removed from nixpkgs.")
  43     (mkRemovedOptionModule [ "programs" "tilp2" ] "The corresponding package was removed from nixpkgs.")
  44     (mkRemovedOptionModule [ "programs" "way-cooler" ] ("way-cooler is abandoned by its author: " +
  45       "https://way-cooler.org/blog/2020/01/09/way-cooler-post-mortem.html"))
  46     (mkRemovedOptionModule [ "security" "hideProcessInformation" ] ''
  47         The hidepid module was removed, since the underlying machinery
  48         is broken when using cgroups-v2.
  49     '')
  50     (mkRemovedOptionModule [ "services" "baget" "enable" ] "The baget module was removed due to the upstream package being unmaintained.")
  51     (mkRemovedOptionModule [ "services" "beegfs" ] "The BeeGFS module has been removed")
  52     (mkRemovedOptionModule [ "services" "beegfsEnable" ] "The BeeGFS module has been removed")
  53     (mkRemovedOptionModule [ "services" "cgmanager" "enable"] "cgmanager was deprecated by lxc and therefore removed from nixpkgs.")
  54     (mkRemovedOptionModule [ "services" "chronos" ] "The corresponding package was removed from nixpkgs.")
  55     (mkRemovedOptionModule [ "services" "couchpotato" ] "The corresponding package was removed from nixpkgs.")
  56     (mkRemovedOptionModule [ "services" "dd-agent" ] "dd-agent was removed from nixpkgs in favor of the newer datadog-agent.")
  57     (mkRemovedOptionModule [ "services" "dnscrypt-proxy" ] "Use services.dnscrypt-proxy2 instead")
  58     (mkRemovedOptionModule [ "services" "exhibitor" ] "The corresponding package was removed from nixpkgs.")
  59     (mkRemovedOptionModule [ "services" "firefox" "syncserver" ] "The corresponding package was removed from nixpkgs.")
  60     (mkRemovedOptionModule [ "services" "flashpolicyd" ] "The flashpolicyd module has been removed. Adobe Flash Player is deprecated.")
  61     (mkRemovedOptionModule [ "services" "fourStore" ] "The fourStore module has been removed")
  62     (mkRemovedOptionModule [ "services" "fourStoreEndpoint" ] "The fourStoreEndpoint module has been removed")
  63     (mkRemovedOptionModule [ "services" "fprot" ] "The corresponding package was removed from nixpkgs.")
  64     (mkRemovedOptionModule [ "services" "frab" ] "The frab module has been removed")
  65     (mkRemovedOptionModule [ "services" "ihatemoney" ] "The ihatemoney module has been removed for lack of downstream maintainer")
  66     (mkRemovedOptionModule [ "services" "kippo" ] "The corresponding package was removed from nixpkgs.")
  67     (mkRemovedOptionModule [ "services" "mailpile" ] "The corresponding package was removed from nixpkgs.")
  68     (mkRemovedOptionModule [ "services" "marathon" ] "The corresponding package was removed from nixpkgs.")
  69     (mkRemovedOptionModule [ "services" "mathics" ] "The Mathics module has been removed")
  70     (mkRemovedOptionModule [ "services" "meguca" ] "Use meguca has been removed from nixpkgs")
  71     (mkRemovedOptionModule [ "services" "mesos" ] "The corresponding package was removed from nixpkgs.")
  72     (mkRemovedOptionModule [ "services" "moinmoin" ] "The corresponding package was removed from nixpkgs.")
  73     (mkRemovedOptionModule [ "services" "mwlib" ] "The corresponding package was removed from nixpkgs.")
  74     (mkRemovedOptionModule [ "services" "pantheon" "files" ] ''
  75       This module was removed, please add pkgs.pantheon.elementary-files to environment.systemPackages directly.
  76     '')
  77     (mkRemovedOptionModule [ "services" "prey" ] ''
  78       prey-bash-client is deprecated upstream
  79     '')
  80     (mkRemovedOptionModule [ "services" "quagga" ] "the corresponding package has been removed from nixpkgs")
  81     (mkRemovedOptionModule [ "services" "railcar" ] "the corresponding package has been removed from nixpkgs")
  82     (mkRemovedOptionModule [ "services" "seeks" ] "")
  83     (mkRemovedOptionModule [ "services" "ssmtp" ] ''
  84       The ssmtp package and the corresponding module have been removed due to
  85       the program being unmaintained. The options `programs.msmtp.*` can be
  86       used instead.
  87     '')
  88     (mkRemovedOptionModule [ "services" "venus" ] "The corresponding package was removed from nixpkgs.")
  89     (mkRemovedOptionModule [ "services" "wakeonlan"] "This module was removed in favor of enabling it with networking.interfaces.<name>.wakeOnLan")
  90     (mkRemovedOptionModule [ "services" "winstone" ] "The corresponding package was removed from nixpkgs.")
  91     (mkRemovedOptionModule [ "services" "xserver" "displayManager" "auto" ] ''
  92       The services.xserver.displayManager.auto module has been removed
  93       because it was only intended for use in internal NixOS tests, and gave the
  94       false impression of it being a special display manager when it's actually
  95       LightDM. Please use the services.xserver.displayManager.autoLogin options
  96       instead, or any other display manager in NixOS as they all support auto-login.
  97     '')
  98     (mkRemovedOptionModule [ "services" "xserver" "multitouch" ] ''
  99       services.xserver.multitouch (which uses xf86_input_mtrack) has been removed
 100       as the underlying package isn't being maintained. Working alternatives are
 101       libinput and synaptics.
 102     '')
 103     (mkRemovedOptionModule [ "virtualisation" "rkt" ] "The rkt module has been removed, it was archived by upstream")
 104     (mkRemovedOptionModule [ "services" "racoon" ] ''
 105       The racoon module has been removed, because the software project was abandoned upstream.
 106     '')
 107     (mkRemovedOptionModule [ "services" "shellinabox" ] "The corresponding package was removed from nixpkgs.")
 108     (mkRemovedOptionModule [ "services" "gogoclient" ] "The corresponding package was removed from nixpkgs.")
 109     (mkRemovedOptionModule [ "services" "virtuoso" ] "The corresponding package was removed from nixpkgs.")
 110     (mkRemovedOptionModule [ "services" "openfire" ] "The corresponding package was removed from nixpkgs.")
 111     (mkRemovedOptionModule [ "services" "riak" ] "The corresponding package was removed from nixpkgs.")
 112     (mkRemovedOptionModule [ "services" "cryptpad" ] "The corresponding package was removed from nixpkgs.")
 113     (mkRemovedOptionModule [ "services" "rtsp-simple-server" ] "Package has been completely rebranded by upstream as mediamtx, and thus the service and the package were renamed in NixOS as well.")
 114     (mkRemovedOptionModule [ "services" "prayer" ] "The corresponding package was removed from nixpkgs.")
 115
 116     (mkRemovedOptionModule [ "i18n" "inputMethod" "fcitx" ] "The fcitx module has been removed. Please use fcitx5 instead")
 117     (mkRemovedOptionModule [ "services" "dhcpd4" ] ''
 118       The dhcpd4 module has been removed because ISC DHCP reached its end of life.
 119       See https://www.isc.org/blogs/isc-dhcp-eol/ for details.
 120       Please switch to a different implementation like kea or dnsmasq.
 121     '')
 122     (mkRemovedOptionModule [ "services" "dhcpd6" ] ''
 123       The dhcpd6 module has been removed because ISC DHCP reached its end of life.
 124       See https://www.isc.org/blogs/isc-dhcp-eol/ for details.
 125       Please switch to a different implementation like kea or dnsmasq.
 126     '')
 127     (mkRemovedOptionModule [ "services" "tedicross" ] ''
 128       The corresponding package was broken and removed from nixpkgs.
 129     '')
 130
 131     # Do NOT add any option renames here, see top of the file
 132   ];
 133 }