commit 5f197bf5d0eaee359dc5c3eb4deabf1654c81b72 · pyrox.dev/nixpkgs

-28

nixos/doc/manual/development/importing-modules.section.md

···

       16
       16
        
         services.exampleModule.enable = true;

     

       17
       17
        
       }

     

       18
       18
        
       ```

     

       19
       19
       -
       

     

       20
       20
       -
       The environment variable `NIXOS_EXTRA_MODULE_PATH` is an absolute path

     

       21
       21
       -
       to a NixOS module that is included alongside the Nixpkgs NixOS modules.

     

       22
       22
       -
       Like any NixOS module, this module can import additional modules:

     

       23
       23
       -
       

     

       24
       24
       -
       ```nix

     

       25
       25
       -
       # ./module-list/default.nix

     

       26
       26
       -
       [

     

       27
       27
       -
         ./example-module1

     

       28
       28
       -
         ./example-module2

     

       29
       29
       -
       ]

     

       30
       30
       -
       ```

     

       31
       31
       -
       

     

       32
       32
       -
       ```nix

     

       33
       33
       -
       # ./extra-module/default.nix

     

       34
       34
       -
       { imports = import ./module-list.nix; }

     

       35
       35
       -
       ```

     

       36
       36
       -
       

     

       37
       37
       -
       ```nix

     

       38
       38
       -
       # NIXOS_EXTRA_MODULE_PATH=/absolute/path/to/extra-module

     

       39
       39
       -
       { config, lib, pkgs, ... }:

     

       40
       40
       -
       

     

       41
       41
       -
       {

     

       42
       42
       -
         # No `imports` needed

     

       43
       43
       -
       

     

       44
       44
       -
         services.exampleModule1.enable = true;

     

       45
       45
       -
       }

     

       46
       46
       -
       ```

+1 -1

nixos/doc/manual/development/meta-attributes.section.md

···

       45
       45
        
       -  `buildDocsInSandbox` indicates whether the option documentation for the

     

       46
       46
        
          module can be built in a derivation sandbox. This option is currently only

     

       47
       47
        
          honored for modules shipped by nixpkgs. User modules and modules taken from

     

       48
       48
       -
          `NIXOS_EXTRA_MODULE_PATH` are always built outside of the sandbox, as has

     

       48
       48
       +
          `extraModules` are always built outside of the sandbox, as has

     

       49
       49
        
          been the case in previous releases.

     

       50
       50
        
       

     

       51
       51
        
          Building NixOS option documentation in a sandbox allows caching of the built

+23 -2

nixos/lib/eval-config.nix

···

       30
       30
        
         check ? true

     

       31
       31
        
       , prefix ? []

     

       32
       32
        
       , lib ? import ../../lib

     

       33
       33
       -
       , extraModules ? let e = builtins.getEnv "NIXOS_EXTRA_MODULE_PATH";

     

       34
       34
       -
                        in lib.optional (e != "") (import e)

     

       33
       33
       +
       , extraModules ?

     

       34
       34
       +
           let e = builtins.getEnv "NIXOS_EXTRA_MODULE_PATH";

     

       35
       35
       +
           in lib.optional (e != "") (

     

       36
       36
       +
             lib.warn

     

       37
       37
       +
               ''

     

       38
       38
       +
                 The NIXOS_EXTRA_MODULE_PATH environment variable is deprecated and will be

     

       39
       39
       +
                 removed in NixOS 25.05.

     

       40
       40
       +
                 We recommend a workflow where you update the expression files instead, but

     

       41
       41
       +
                 if you wish to continue to use this variable, you may do so with a module like:

     

       42
       42
       +
       

     

       43
       43
       +
                 {

     

       44
       44
       +
                   imports = [

     

       45
       45
       +
                     (builtins.getEnv "NIXOS_EXTRA_MODULE_PATH")

     

       46
       46
       +
                   ];

     

       47
       47
       +
                 }

     

       48
       48
       +
       

     

       49
       49
       +
                 This has the benefit that your configuration hints at the

     

       50
       50
       +
                 non-standard workflow.

     

       51
       51
       +
               ''

     

       52
       52
       +
               # NOTE: this import call is unnecessary and it even removes the file name

     

       53
       53
       +
               #       from error messages.

     

       54
       54
       +
               import e

     

       55
       55
       +
           )

     

       35
       56
        
       }:

     

       36
       57
        
       

     

       37
       58
        
       let