Unverified Commit 591e302b authored by Emily's avatar Emily Committed by GitHub
Browse files

lib: deprecate mkAliasOptionModuleMD (#454195)

parents adb5d91c def801fb

doc/release-notes/rl-2511.section.md

+2 −0
Original line number Diff line number Diff line
@@ -345,6 +345,8 @@ 


### Deprecations {#sec-nixpkgs-release-25.11-lib-deprecations}



- `lib.options.mkAliasOptionModuleMD` is now obsolete; use the identical [`lib.options.mkAliasOptionModule`] instead.



- `types.either` silently accepted mismatching types when used in `freeformType`. Module maintainers should fix the used type

  In most cases wrapping `either` with `attrsOf` should be sufficient.

lib/modules.nix

+3 −4
Original line number Diff line number Diff line
@@ -1787,11 +1787,10 @@ let 
    };



  /**

    Transitional version of mkAliasOptionModule that uses MD docs.



    This function is no longer necessary and merely an alias of `mkAliasOptionModule`.

    Deprecated alias of mkAliasOptionModule that uses MD docs.

    This function is no longer necessary will be removed in 26.05`.

  */

  mkAliasOptionModuleMD = mkAliasOptionModule;

  mkAliasOptionModuleMD = lib.warn "mkAliasOptionModuleMD is deprecated and will be removed in 26.05; please use mkAliasOptionModule." mkAliasOptionModule;



  /**

    mkDerivedConfig : Option a -> (a -> Definition b) -> Definition b

nixos/modules/config/users-groups.nix

+3 −3
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ let 
    mapAttrs'

    mapAttrsToList

    match

    mkAliasOptionModuleMD

    mkAliasOptionModule

    mkDefault

    mkIf

    mkMerge
@@ -666,8 +666,8 @@ let 
in

{

  imports = [

    (mkAliasOptionModuleMD [ "users" "extraUsers" ] [ "users" "users" ])

    (mkAliasOptionModuleMD [ "users" "extraGroups" ] [ "users" "groups" ])

    (mkAliasOptionModule [ "users" "extraUsers" ] [ "users" "users" ])

    (mkAliasOptionModule [ "users" "extraGroups" ] [ "users" "groups" ])

    (mkRenamedOptionModule

      [ "security" "initialRootPassword" ]

      [ "users" "users" "root" "initialHashedPassword" ]

nixos/modules/rename.nix

+2 −2
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 


let

  inherit (lib)

    mkAliasOptionModuleMD

    mkAliasOptionModule

    mkRemovedOptionModule

    ;

in
@@ -18,7 +18,7 @@ in 


    # This alias module can't be where _module.check is defined because it would

    # be added to submodules as well there

    (mkAliasOptionModuleMD [ "environment" "checkConfigurationOptions" ] [ "_module" "check" ])

    (mkAliasOptionModule [ "environment" "checkConfigurationOptions" ] [ "_module" "check" ])



    # Completely removed modules

    (mkRemovedOptionModule [ "boot" "loader" "raspberryPi" ]

nixos/modules/services/networking/ssh/sshd.nix

+2 −2
Original line number Diff line number Diff line
@@ -177,8 +177,8 @@ in 


{

  imports = [

    (lib.mkAliasOptionModuleMD [ "services" "sshd" "enable" ] [ "services" "openssh" "enable" ])

    (lib.mkAliasOptionModuleMD [ "services" "openssh" "knownHosts" ] [ "programs" "ssh" "knownHosts" ])

    (lib.mkAliasOptionModule [ "services" "sshd" "enable" ] [ "services" "openssh" "enable" ])

    (lib.mkAliasOptionModule [ "services" "openssh" "knownHosts" ] [ "programs" "ssh" "knownHosts" ])

    (lib.mkRenamedOptionModule

      [ "services" "openssh" "challengeResponseAuthentication" ]

      [ "services" "openssh" "kbdInteractiveAuthentication" ]