mkRenamedOptionModuleWith

lib.modules.mkRenamedOptionModuleWith

Docs pulled from | This Revision | 18 days ago

Contribute

Enhance the ecosystem with your expertise! Contribute to fill the gaps in documentation. Your input can make a difference.

Write API documentation for this function
Learn how to write documentation

Noogle detected

Aliases

lib.mkRenamedOptionModuleWith

Implementation

The following is the current implementation of this function.

{
      /**
        Old option path as list of strings.
      */
      from,
      /**
        New option path as list of strings.
      */
      to,
      /**
        Release number of the first release that contains the rename, ignoring backports.
        Set it to the upcoming release, matching the nixpkgs/.version file.
      */
      sinceRelease,
    }:
    doRename {
      inherit from to;
      visible = false;
      warn = oldestSupportedReleaseIsAtLeast sinceRelease;
      use = warnIf (oldestSupportedReleaseIsAtLeast sinceRelease) "Obsolete option `${showOption from}' is used. It was renamed to `${showOption to}'.";
    }