gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/eval-config: Deprecate NIXOS_EXTRA_MODULE_PATH (#349549)

Browse Source
This commit is contained in:
Robert Hensing
2025-01-05 20:51:20 +01:00
committed by GitHub
parent 6bff619479 5f197bf5d0
commit 04a5fd4b4f
3 changed files with 24 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
nixos/doc/manual/development/importing-modules.section.md
View File

@@ -16,31 +16,3 @@ outside of Nixpkgs. These modules can be imported:
services.exampleModule.enable = true; services.exampleModule.enable = true;
} }
``` ```
The environment variable `NIXOS_EXTRA_MODULE_PATH` is an absolute path
to a NixOS module that is included alongside the Nixpkgs NixOS modules.
Like any NixOS module, this module can import additional modules:
```nix
# ./module-list/default.nix
[
./example-module1
./example-module2
]
```
```nix
# ./extra-module/default.nix
{ imports = import ./module-list.nix; }
```
```nix
# NIXOS_EXTRA_MODULE_PATH=/absolute/path/to/extra-module
{ config, lib, pkgs, ... }:
{
# No `imports` needed
services.exampleModule1.enable = true;
}
```

2
nixos/doc/manual/development/meta-attributes.section.md
View File

@@ -45,7 +45,7 @@ file.
- `buildDocsInSandbox` indicates whether the option documentation for the - `buildDocsInSandbox` indicates whether the option documentation for the
module can be built in a derivation sandbox. This option is currently only module can be built in a derivation sandbox. This option is currently only
honored for modules shipped by nixpkgs. User modules and modules taken from honored for modules shipped by nixpkgs. User modules and modules taken from
`NIXOS_EXTRA_MODULE_PATH` are always built outside of the sandbox, as has `extraModules` are always built outside of the sandbox, as has
been the case in previous releases. been the case in previous releases.
Building NixOS option documentation in a sandbox allows caching of the built Building NixOS option documentation in a sandbox allows caching of the built

25
nixos/lib/eval-config.nix
View File

@@ -30,8 +30,29 @@ evalConfigArgs@
check ? true check ? true
, prefix ? [] , prefix ? []
, lib ? import ../../lib , lib ? import ../../lib
, extraModules ? let e = builtins.getEnv "NIXOS_EXTRA_MODULE_PATH"; , extraModules ?
in lib.optional (e != "") (import e) let e = builtins.getEnv "NIXOS_EXTRA_MODULE_PATH";
in lib.optional (e != "") (
lib.warn
''
The NIXOS_EXTRA_MODULE_PATH environment variable is deprecated and will be
removed in NixOS 25.05.
We recommend a workflow where you update the expression files instead, but
if you wish to continue to use this variable, you may do so with a module like:
{
imports = [
(builtins.getEnv "NIXOS_EXTRA_MODULE_PATH")
];
}
This has the benefit that your configuration hints at the
non-standard workflow.
''
# NOTE: this import call is unnecessary and it even removes the file name
# from error messages.
import e
)
}: }:
let let