commit a743c6d35a8e59aa8d0d92494c8e00a525a384f8 · pyrox.dev/nixpkgs

+64

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

···

       1
       1
       +
       # Replace Modules {#sec-replace-modules}

     

       2
       2
       +
       

     

       3
       3
       +
       Modules that are imported can also be disabled. The option declarations,

     

       4
       4
       +
       config implementation and the imports of a disabled module will be

     

       5
       5
       +
       ignored, allowing another to take it\'s place. This can be used to

     

       6
       6
       +
       import a set of modules from another channel while keeping the rest of

     

       7
       7
       +
       the system on a stable release.

     

       8
       8
       +
       

     

       9
       9
       +
       `disabledModules` is a top level attribute like `imports`, `options` and

     

       10
       10
       +
       `config`. It contains a list of modules that will be disabled. This can

     

       11
       11
       +
       either be the full path to the module or a string with the filename

     

       12
       12
       +
       relative to the modules path (eg. \<nixpkgs/nixos/modules> for nixos).

     

       13
       13
       +
       

     

       14
       14
       +
       This example will replace the existing postgresql module with the

     

       15
       15
       +
       version defined in the nixos-unstable channel while keeping the rest of

     

       16
       16
       +
       the modules and packages from the original nixos channel. This only

     

       17
       17
       +
       overrides the module definition, this won\'t use postgresql from

     

       18
       18
       +
       nixos-unstable unless explicitly configured to do so.

     

       19
       19
       +
       

     

       20
       20
       +
       ```nix

     

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

     

       22
       22
       +
       

     

       23
       23
       +
       {

     

       24
       24
       +
         disabledModules = [ "services/databases/postgresql.nix" ];

     

       25
       25
       +
       

     

       26
       26
       +
         imports =

     

       27
       27
       +
           [ # Use postgresql service from nixos-unstable channel.

     

       28
       28
       +
             # sudo nix-channel --add https://nixos.org/channels/nixos-unstable nixos-unstable

     

       29
       29
       +
             <nixos-unstable/nixos/modules/services/databases/postgresql.nix>

     

       30
       30
       +
           ];

     

       31
       31
       +
       

     

       32
       32
       +
         services.postgresql.enable = true;

     

       33
       33
       +
       }

     

       34
       34
       +
       ```

     

       35
       35
       +
       

     

       36
       36
       +
       This example shows how to define a custom module as a replacement for an

     

       37
       37
       +
       existing module. Importing this module will disable the original module

     

       38
       38
       +
       without having to know it\'s implementation details.

     

       39
       39
       +
       

     

       40
       40
       +
       ```nix

     

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

     

       42
       42
       +
       

     

       43
       43
       +
       with lib;

     

       44
       44
       +
       

     

       45
       45
       +
       let

     

       46
       46
       +
         cfg = config.programs.man;

     

       47
       47
       +
       in

     

       48
       48
       +
       

     

       49
       49
       +
       {

     

       50
       50
       +
         disabledModules = [ "services/programs/man.nix" ];

     

       51
       51
       +
       

     

       52
       52
       +
         options = {

     

       53
       53
       +
           programs.man.enable = mkOption {

     

       54
       54
       +
             type = types.bool;

     

       55
       55
       +
             default = true;

     

       56
       56
       +
             description = "Whether to enable manual pages.";

     

       57
       57
       +
           };

     

       58
       58
       +
         };

     

       59
       59
       +
       

     

       60
       60
       +
         config = mkIf cfg.enabled {

     

       61
       61
       +
           warnings = [ "disabled manpages for production deployments." ];

     

       62
       62
       +
         };

     

       63
       63
       +
       }

     

       64
       64
       +
       ```

-79

nixos/doc/manual/development/replace-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-replace-modules">

     

       6
       6
       -
        <title>Replace Modules</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         Modules that are imported can also be disabled. The option declarations,

     

       10
       10
       -
         config implementation and the imports of a disabled module will be ignored, allowing another

     

       11
       11
       -
         to take it's place. This can be used to import a set of modules from another

     

       12
       12
       -
         channel while keeping the rest of the system on a stable release.

     

       13
       13
       -
        </para>

     

       14
       14
       -
       

     

       15
       15
       -
        <para>

     

       16
       16
       -
         <literal>disabledModules</literal> is a top level attribute like

     

       17
       17
       -
         <literal>imports</literal>, <literal>options</literal> and

     

       18
       18
       -
         <literal>config</literal>. It contains a list of modules that will be

     

       19
       19
       -
         disabled. This can either be the full path to the module or a string with the

     

       20
       20
       -
         filename relative to the modules path (eg. &lt;nixpkgs/nixos/modules&gt; for

     

       21
       21
       -
         nixos).

     

       22
       22
       -
        </para>

     

       23
       23
       -
       

     

       24
       24
       -
        <para>

     

       25
       25
       -
         This example will replace the existing postgresql module with the version

     

       26
       26
       -
         defined in the nixos-unstable channel while keeping the rest of the modules

     

       27
       27
       -
         and packages from the original nixos channel. This only overrides the module

     

       28
       28
       -
         definition, this won't use postgresql from nixos-unstable unless explicitly

     

       29
       29
       -
         configured to do so.

     

       30
       30
       -
        </para>

     

       31
       31
       -
       

     

       32
       32
       -
       <programlisting>

     

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

     

       34
       34
       -
       

     

       35
       35
       -
       {

     

       36
       36
       -
         disabledModules = [ "services/databases/postgresql.nix" ];

     

       37
       37
       -
       

     

       38
       38
       -
         imports =

     

       39
       39
       -
           [ # Use postgresql service from nixos-unstable channel.

     

       40
       40
       -
             # sudo nix-channel --add https://nixos.org/channels/nixos-unstable nixos-unstable

     

       41
       41
       -
             &lt;nixos-unstable/nixos/modules/services/databases/postgresql.nix&gt;

     

       42
       42
       -
           ];

     

       43
       43
       -
       

     

       44
       44
       -
         services.postgresql.enable = true;

     

       45
       45
       -
       }

     

       46
       46
       -
       </programlisting>

     

       47
       47
       -
       

     

       48
       48
       -
        <para>

     

       49
       49
       -
         This example shows how to define a custom module as a replacement for an

     

       50
       50
       -
         existing module. Importing this module will disable the original module

     

       51
       51
       -
         without having to know it's implementation details.

     

       52
       52
       -
        </para>

     

       53
       53
       -
       

     

       54
       54
       -
       <programlisting>

     

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

     

       56
       56
       -
       

     

       57
       57
       -
       with lib;

     

       58
       58
       -
       

     

       59
       59
       -
       let

     

       60
       60
       -
         cfg = config.programs.man;

     

       61
       61
       -
       in

     

       62
       62
       -
       

     

       63
       63
       -
       {

     

       64
       64
       -
         disabledModules = [ "services/programs/man.nix" ];

     

       65
       65
       -
       

     

       66
       66
       -
         options = {

     

       67
       67
       -
           programs.man.enable = mkOption {

     

       68
       68
       -
             type = types.bool;

     

       69
       69
       -
             default = true;

     

       70
       70
       -
             description = "Whether to enable manual pages.";

     

       71
       71
       -
           };

     

       72
       72
       -
         };

     

       73
       73
       -
       

     

       74
       74
       -
         config = mkIf cfg.enabled {

     

       75
       75
       -
           warnings = [ "disabled manpages for production deployments." ];

     

       76
       76
       -
         };

     

       77
       77
       -
       }

     

       78
       78
       -
       </programlisting>

     

       79
       79
       -
       </section>

+1 -1

nixos/doc/manual/development/writing-modules.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="../from_md/development/importing-modules.section.xml" />

     

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

     

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

     

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

     

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

     

       191
       191
        
       </chapter>

+70

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

···

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

     

       2
       2
       +
         <title>Replace Modules</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           Modules that are imported can also be disabled. The option

     

       5
       5
       +
           declarations, config implementation and the imports of a disabled

     

       6
       6
       +
           module will be ignored, allowing another to take it's place. This

     

       7
       7
       +
           can be used to import a set of modules from another channel while

     

       8
       8
       +
           keeping the rest of the system on a stable release.

     

       9
       9
       +
         </para>

     

       10
       10
       +
         <para>

     

       11
       11
       +
           <literal>disabledModules</literal> is a top level attribute like

     

       12
       12
       +
           <literal>imports</literal>, <literal>options</literal> and

     

       13
       13
       +
           <literal>config</literal>. It contains a list of modules that will

     

       14
       14
       +
           be disabled. This can either be the full path to the module or a

     

       15
       15
       +
           string with the filename relative to the modules path (eg.

     

       16
       16
       +
           &lt;nixpkgs/nixos/modules&gt; for nixos).

     

       17
       17
       +
         </para>

     

       18
       18
       +
         <para>

     

       19
       19
       +
           This example will replace the existing postgresql module with the

     

       20
       20
       +
           version defined in the nixos-unstable channel while keeping the rest

     

       21
       21
       +
           of the modules and packages from the original nixos channel. This

     

       22
       22
       +
           only overrides the module definition, this won't use postgresql from

     

       23
       23
       +
           nixos-unstable unless explicitly configured to do so.

     

       24
       24
       +
         </para>

     

       25
       25
       +
         <programlisting language="bash">

     

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

     

       27
       27
       +
       

     

       28
       28
       +
       {

     

       29
       29
       +
         disabledModules = [ &quot;services/databases/postgresql.nix&quot; ];

     

       30
       30
       +
       

     

       31
       31
       +
         imports =

     

       32
       32
       +
           [ # Use postgresql service from nixos-unstable channel.

     

       33
       33
       +
             # sudo nix-channel --add https://nixos.org/channels/nixos-unstable nixos-unstable

     

       34
       34
       +
             &lt;nixos-unstable/nixos/modules/services/databases/postgresql.nix&gt;

     

       35
       35
       +
           ];

     

       36
       36
       +
       

     

       37
       37
       +
         services.postgresql.enable = true;

     

       38
       38
       +
       }

     

       39
       39
       +
       </programlisting>

     

       40
       40
       +
         <para>

     

       41
       41
       +
           This example shows how to define a custom module as a replacement

     

       42
       42
       +
           for an existing module. Importing this module will disable the

     

       43
       43
       +
           original module without having to know it's implementation details.

     

       44
       44
       +
         </para>

     

       45
       45
       +
         <programlisting language="bash">

     

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

     

       47
       47
       +
       

     

       48
       48
       +
       with lib;

     

       49
       49
       +
       

     

       50
       50
       +
       let

     

       51
       51
       +
         cfg = config.programs.man;

     

       52
       52
       +
       in

     

       53
       53
       +
       

     

       54
       54
       +
       {

     

       55
       55
       +
         disabledModules = [ &quot;services/programs/man.nix&quot; ];

     

       56
       56
       +
       

     

       57
       57
       +
         options = {

     

       58
       58
       +
           programs.man.enable = mkOption {

     

       59
       59
       +
             type = types.bool;

     

       60
       60
       +
             default = true;

     

       61
       61
       +
             description = &quot;Whether to enable manual pages.&quot;;

     

       62
       62
       +
           };

     

       63
       63
       +
         };

     

       64
       64
       +
       

     

       65
       65
       +
         config = mkIf cfg.enabled {

     

       66
       66
       +
           warnings = [ &quot;disabled manpages for production deployments.&quot; ];

     

       67
       67
       +
         };

     

       68
       68
       +
       }

     

       69
       69
       +
       </programlisting>

     

       70
       70
       +
       </section>