commit c0853101833136590811a8c3cf30a989dd40a586 · pyrox.dev/nixpkgs

+40

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

···

       1
       1
       +
       # Meta Attributes {#sec-meta-attributes}

     

       2
       2
       +
       

     

       3
       3
       +
       Like Nix packages, NixOS modules can declare meta-attributes to provide

     

       4
       4
       +
       extra information. Module meta attributes are defined in the `meta.nix`

     

       5
       5
       +
       special module.

     

       6
       6
       +
       

     

       7
       7
       +
       `meta` is a top level attribute like `options` and `config`. Available

     

       8
       8
       +
       meta-attributes are `maintainers` and `doc`.

     

       9
       9
       +
       

     

       10
       10
       +
       Each of the meta-attributes must be defined at most once per module

     

       11
       11
       +
       file.

     

       12
       12
       +
       

     

       13
       13
       +
       ```nix

     

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

     

       15
       15
       +
       {

     

       16
       16
       +
         options = {

     

       17
       17
       +
           ...

     

       18
       18
       +
         };

     

       19
       19
       +
       

     

       20
       20
       +
         config = {

     

       21
       21
       +
           ...

     

       22
       22
       +
         };

     

       23
       23
       +
       

     

       24
       24
       +
         meta = {

     

       25
       25
       +
           maintainers = with lib.maintainers; [ ericsagnes ];

     

       26
       26
       +
           doc = ./default.xml;

     

       27
       27
       +
         };

     

       28
       28
       +
       }

     

       29
       29
       +
       ```

     

       30
       30
       +
       

     

       31
       31
       +
       -   `maintainers` contains a list of the module maintainers.

     

       32
       32
       +
       

     

       33
       33
       +
       -   `doc` points to a valid DocBook file containing the module

     

       34
       34
       +
           documentation. Its contents is automatically added to

     

       35
       35
       +
           [](#ch-configuration). Changes to a module documentation have to

     

       36
       36
       +
           be checked to not break building the NixOS manual:

     

       37
       37
       +
       

     

       38
       38
       +
           ```ShellSession

     

       39
       39
       +
           $ nix-build nixos/release.nix -A manual.x86_64-linux

     

       40
       40
       +
           ```

-63

nixos/doc/manual/development/meta-attributes.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-meta-attributes">

     

       6
       6
       -
        <title>Meta Attributes</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         Like Nix packages, NixOS modules can declare meta-attributes to provide extra

     

       10
       10
       -
         information. Module meta attributes are defined in the

     

       11
       11
       -
         <filename

     

       12
       12
       -
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename>

     

       13
       13
       -
         special module.

     

       14
       14
       -
        </para>

     

       15
       15
       -
       

     

       16
       16
       -
        <para>

     

       17
       17
       -
         <literal>meta</literal> is a top level attribute like

     

       18
       18
       -
         <literal>options</literal> and <literal>config</literal>. Available

     

       19
       19
       -
         meta-attributes are <literal>maintainers</literal> and

     

       20
       20
       -
         <literal>doc</literal>.

     

       21
       21
       -
        </para>

     

       22
       22
       -
       

     

       23
       23
       -
        <para>

     

       24
       24
       -
         Each of the meta-attributes must be defined at most once per module file.

     

       25
       25
       -
        </para>

     

       26
       26
       -
       

     

       27
       27
       -
       <programlisting>

     

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

     

       29
       29
       -
       {

     

       30
       30
       -
         options = {

     

       31
       31
       -
           ...

     

       32
       32
       -
         };

     

       33
       33
       -
       

     

       34
       34
       -
         config = {

     

       35
       35
       -
           ...

     

       36
       36
       -
         };

     

       37
       37
       -
       

     

       38
       38
       -
         meta = {

     

       39
       39
       -
           maintainers = with lib.maintainers; [ ericsagnes ]; <co

     

       40
       40
       -
             xml:id='modules-meta-1' />

     

       41
       41
       -
           doc = ./default.xml; <co xml:id='modules-meta-2' />

     

       42
       42
       -
         };

     

       43
       43
       -
       }

     

       44
       44
       -
       </programlisting>

     

       45
       45
       -
       

     

       46
       46
       -
        <calloutlist>

     

       47
       47
       -
         <callout arearefs='modules-meta-1'>

     

       48
       48
       -
          <para>

     

       49
       49
       -
           <varname>maintainers</varname> contains a list of the module maintainers.

     

       50
       50
       -
          </para>

     

       51
       51
       -
         </callout>

     

       52
       52
       -
         <callout arearefs='modules-meta-2'>

     

       53
       53
       -
          <para>

     

       54
       54
       -
           <varname>doc</varname> points to a valid DocBook file containing the module

     

       55
       55
       -
           documentation. Its contents is automatically added to

     

       56
       56
       -
           <xref

     

       57
       57
       -
             linkend="ch-configuration"/>. Changes to a module documentation

     

       58
       58
       -
           have to be checked to not break building the NixOS manual:

     

       59
       59
       -
          </para>

     

       60
       60
       -
       <screen><prompt>$ </prompt>nix-build nixos/release.nix -A manual.x86_64-linux</screen>

     

       61
       61
       -
         </callout>

     

       62
       62
       -
        </calloutlist>

     

       63
       63
       -
       </section>

+1 -1

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

···

       183
       183
        
        <xi:include href="../from_md/development/option-types.section.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="meta-attributes.xml" />

     

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

     

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

     

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

     

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

+55

nixos/doc/manual/from_md/development/meta-attributes.section.xml

···

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

     

       2
       2
       +
         <title>Meta Attributes</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           Like Nix packages, NixOS modules can declare meta-attributes to

     

       5
       5
       +
           provide extra information. Module meta attributes are defined in the

     

       6
       6
       +
           <literal>meta.nix</literal> special module.

     

       7
       7
       +
         </para>

     

       8
       8
       +
         <para>

     

       9
       9
       +
           <literal>meta</literal> is a top level attribute like

     

       10
       10
       +
           <literal>options</literal> and <literal>config</literal>. Available

     

       11
       11
       +
           meta-attributes are <literal>maintainers</literal> and

     

       12
       12
       +
           <literal>doc</literal>.

     

       13
       13
       +
         </para>

     

       14
       14
       +
         <para>

     

       15
       15
       +
           Each of the meta-attributes must be defined at most once per module

     

       16
       16
       +
           file.

     

       17
       17
       +
         </para>

     

       18
       18
       +
         <programlisting language="bash">

     

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

     

       20
       20
       +
       {

     

       21
       21
       +
         options = {

     

       22
       22
       +
           ...

     

       23
       23
       +
         };

     

       24
       24
       +
       

     

       25
       25
       +
         config = {

     

       26
       26
       +
           ...

     

       27
       27
       +
         };

     

       28
       28
       +
       

     

       29
       29
       +
         meta = {

     

       30
       30
       +
           maintainers = with lib.maintainers; [ ericsagnes ];

     

       31
       31
       +
           doc = ./default.xml;

     

       32
       32
       +
         };

     

       33
       33
       +
       }

     

       34
       34
       +
       </programlisting>

     

       35
       35
       +
         <itemizedlist>

     

       36
       36
       +
           <listitem>

     

       37
       37
       +
             <para>

     

       38
       38
       +
               <literal>maintainers</literal> contains a list of the module

     

       39
       39
       +
               maintainers.

     

       40
       40
       +
             </para>

     

       41
       41
       +
           </listitem>

     

       42
       42
       +
           <listitem>

     

       43
       43
       +
             <para>

     

       44
       44
       +
               <literal>doc</literal> points to a valid DocBook file containing

     

       45
       45
       +
               the module documentation. Its contents is automatically added to

     

       46
       46
       +
               <xref linkend="ch-configuration" />. Changes to a module

     

       47
       47
       +
               documentation have to be checked to not break building the NixOS

     

       48
       48
       +
               manual:

     

       49
       49
       +
             </para>

     

       50
       50
       +
             <programlisting>

     

       51
       51
       +
       $ nix-build nixos/release.nix -A manual.x86_64-linux

     

       52
       52
       +
       </programlisting>

     

       53
       53
       +
           </listitem>

     

       54
       54
       +
         </itemizedlist>

     

       55
       55
       +
       </section>