commit 9afb04f765bba1015314efb723a58ed68c393021 · pyrox.dev/nixpkgs

+46

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

···

       1
       1
       +
       # Importing Modules {#sec-importing-modules}

     

       2
       2
       +
       

     

       3
       3
       +
       Sometimes NixOS modules need to be used in configuration but exist

     

       4
       4
       +
       outside of Nixpkgs. These modules can be imported:

     

       5
       5
       +
       

     

       6
       6
       +
       ```nix

     

       7
       7
       +
       { config, lib, pkgs, ... }:

     

       8
       8
       +
       

     

       9
       9
       +
       {

     

       10
       10
       +
         imports =

     

       11
       11
       +
           [ # Use a locally-available module definition in

     

       12
       12
       +
             # ./example-module/default.nix

     

       13
       13
       +
               ./example-module

     

       14
       14
       +
           ];

     

       15
       15
       +
       

     

       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
       +
       ```

-56

nixos/doc/manual/development/importing-modules.xml

···

       1
       1
       -
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
                version="5.0"

     

       5
       5
       -
                xml:id="sec-importing-modules">

     

       6
       6
       -
        <title>Importing Modules</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         Sometimes NixOS modules need to be used in configuration but exist outside of

     

       10
       10
       -
         Nixpkgs. These modules can be imported:

     

       11
       11
       -
        </para>

     

       12
       12
       -
       

     

       13
       13
       -
       <programlisting>

     

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

     

       15
       15
       -
       

     

       16
       16
       -
       {

     

       17
       17
       -
         imports =

     

       18
       18
       -
           [ # Use a locally-available module definition in

     

       19
       19
       -
             # ./example-module/default.nix

     

       20
       20
       -
               ./example-module

     

       21
       21
       -
           ];

     

       22
       22
       -
       

     

       23
       23
       -
         services.exampleModule.enable = true;

     

       24
       24
       -
       }

     

       25
       25
       -
       </programlisting>

     

       26
       26
       -
       

     

       27
       27
       -
        <para>

     

       28
       28
       -
         The environment variable <literal>NIXOS_EXTRA_MODULE_PATH</literal> is an

     

       29
       29
       -
         absolute path to a NixOS module that is included alongside the Nixpkgs NixOS

     

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

     

       31
       31
       -
        </para>

     

       32
       32
       -
       

     

       33
       33
       -
       <programlisting>

     

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

     

       35
       35
       -
       [

     

       36
       36
       -
         ./example-module1

     

       37
       37
       -
         ./example-module2

     

       38
       38
       -
       ]

     

       39
       39
       -
       </programlisting>

     

       40
       40
       -
       

     

       41
       41
       -
       <programlisting>

     

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

     

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

     

       44
       44
       -
       </programlisting>

     

       45
       45
       -
       

     

       46
       46
       -
       <programlisting>

     

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

     

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

     

       49
       49
       -
       

     

       50
       50
       -
       {

     

       51
       51
       -
         # No `imports` needed

     

       52
       52
       -
       

     

       53
       53
       -
         services.exampleModule1.enable = true;

     

       54
       54
       -
       }

     

       55
       55
       -
       </programlisting>

     

       56
       56
       -
       </section>

+1 -1

nixos/doc/manual/development/writing-modules.xml

···

       184
       184
        
        <xi:include href="../from_md/development/option-def.section.xml" />

     

       185
       185
        
        <xi:include href="../from_md/development/assertions.section.xml" />

     

       186
       186
        
        <xi:include href="../from_md/development/meta-attributes.section.xml" />

     

       187
       187
       -
        <xi:include href="importing-modules.xml" />

     

       187
       187
       +
        <xi:include href="../from_md/development/importing-modules.section.xml" />

     

       188
       188
        
        <xi:include href="replace-modules.xml" />

     

       189
       189
        
        <xi:include href="freeform-modules.xml" />

     

       190
       190
        
        <xi:include href="settings-options.xml" />

+47

nixos/doc/manual/from_md/development/importing-modules.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-importing-modules">

     

       2
       2
       +
         <title>Importing Modules</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           Sometimes NixOS modules need to be used in configuration but exist

     

       5
       5
       +
           outside of Nixpkgs. These modules can be imported:

     

       6
       6
       +
         </para>

     

       7
       7
       +
         <programlisting language="bash">

     

       8
       8
       +
       { config, lib, pkgs, ... }:

     

       9
       9
       +
       

     

       10
       10
       +
       {

     

       11
       11
       +
         imports =

     

       12
       12
       +
           [ # Use a locally-available module definition in

     

       13
       13
       +
             # ./example-module/default.nix

     

       14
       14
       +
               ./example-module

     

       15
       15
       +
           ];

     

       16
       16
       +
       

     

       17
       17
       +
         services.exampleModule.enable = true;

     

       18
       18
       +
       }

     

       19
       19
       +
       </programlisting>

     

       20
       20
       +
         <para>

     

       21
       21
       +
           The environment variable <literal>NIXOS_EXTRA_MODULE_PATH</literal>

     

       22
       22
       +
           is an absolute path to a NixOS module that is included alongside the

     

       23
       23
       +
           Nixpkgs NixOS modules. Like any NixOS module, this module can import

     

       24
       24
       +
           additional modules:

     

       25
       25
       +
         </para>

     

       26
       26
       +
         <programlisting language="bash">

     

       27
       27
       +
       # ./module-list/default.nix

     

       28
       28
       +
       [

     

       29
       29
       +
         ./example-module1

     

       30
       30
       +
         ./example-module2

     

       31
       31
       +
       ]

     

       32
       32
       +
       </programlisting>

     

       33
       33
       +
         <programlisting language="bash">

     

       34
       34
       +
       # ./extra-module/default.nix

     

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

     

       36
       36
       +
       </programlisting>

     

       37
       37
       +
         <programlisting language="bash">

     

       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
       +
       </programlisting>

     

       47
       47
       +
       </section>