commit 4d3eb9460a3c47d901a8bf37715d25b6ae197c67 · pyrox.dev/nixpkgs

+1

ci/eval/default.nix

···

       30
       30
        
                 "doc"

     

       31
       31
        
                 "lib"

     

       32
       32
        
                 "maintainers"

     

       33
       33
       +
                 "modules"

     

       33
       34
        
                 "nixos"

     

       34
       35
        
                 "pkgs"

     

       35
       36
        
                 ".version"

+32

doc/doc-support/package.nix

···

       15
       15
        
         markdown-code-runner,

     

       16
       16
        
         roboto,

     

       17
       17
        
         treefmt,

     

       18
       18
       +
         nixosOptionsDoc,

     

       18
       19
        
       }:

     

       19
       20
        
       stdenvNoCC.mkDerivation (

     

       20
       21
        
         finalAttrs:

     

       21
       22
        
         let

     

       22
       23
        
           inherit (finalAttrs.finalPackage.optionsDoc) optionsJSON;

     

       23
       24
        
           inherit (finalAttrs.finalPackage) epub lib-docs pythonInterpreterTable;

     

       25
       25
       +
       

     

       26
       26
       +
           # Make anything from lib (the module system internals) invisible

     

       27
       27
       +
           hide-lib =

     

       28
       28
       +
             opt:

     

       29
       29
       +
             opt

     

       30
       30
       +
             // {

     

       31
       31
       +
               visible = if lib.all (decl: decl == "lib/modules.nix") opt.declarations then false else opt.visible;

     

       32
       32
       +
             };

     

       33
       33
       +
       

     

       34
       34
       +
           toURL =

     

       35
       35
       +
             decl:

     

       36
       36
       +
             let

     

       37
       37
       +
               declStr = toString decl;

     

       38
       38
       +
               root = toString (../..);

     

       39
       39
       +
               subpath = lib.removePrefix "/" (lib.removePrefix root declStr);

     

       40
       40
       +
             in

     

       41
       41
       +
             if lib.hasPrefix root declStr then

     

       42
       42
       +
               {

     

       43
       43
       +
                 url = "https://github.com/NixOS/nixpkgs/blob/master/${subpath}";

     

       44
       44
       +
                 name = "nixpkgs/${subpath}";

     

       45
       45
       +
               }

     

       46
       46
       +
             else

     

       47
       47
       +
               decl;

     

       48
       48
       +
       

     

       49
       49
       +
           mapURLs = opt: opt // { declarations = map toURL opt.declarations; };

     

       50
       50
       +
       

     

       51
       51
       +
           docs.generic.meta-maintainers = nixosOptionsDoc {

     

       52
       52
       +
             inherit (lib.evalModules { modules = [ ../../modules/generic/meta-maintainers.nix ]; }) options;

     

       53
       53
       +
             transformOptions = opt: hide-lib (mapURLs opt);

     

       54
       54
       +
           };

     

       24
       55
        
         in

     

       25
       56
        
         {

     

       26
       57
        
           name = "nixpkgs-manual";

     
···

       49
       80
        
             ln -s ${optionsJSON}/share/doc/nixos/options.json ./config-options.json

     

       50
       81
        
             ln -s ${treefmt.functionsDoc.markdown} ./packages/treefmt-functions.section.md

     

       51
       82
        
             ln -s ${treefmt.optionsDoc.optionsJSON}/share/doc/nixos/options.json ./treefmt-options.json

     

       83
       83
       +
             ln -s ${docs.generic.meta-maintainers.optionsJSON}/share/doc/nixos/options.json ./options-modules-generic-meta-maintainers.json

     

       52
       84
        
           '';

     

       53
       85
        
       

     

       54
       86
        
           buildPhase = ''

+1

doc/manual.md.in

···

       11
       11
        
       stdenv.md

     

       12
       12
        
       toolchains.md

     

       13
       13
        
       build-helpers.md

     

       14
       14
       +
       modules/index.md

     

       14
       15
        
       development.md

     

       15
       16
        
       contributing.md

     

       16
       17
        
       interoperability.md

+16

doc/modules/generic.chapter.md

···

       1
       1
       +
       

     

       2
       2
       +
       # Generic {#modules-generic}

     

       3
       3
       +
       

     

       4
       4
       +
       Generic modules can be imported to extend configurations of any [class].

     

       5
       5
       +
       

     

       6
       6
       +
       ## `meta-maintainers.nix` {#modules-generic-meta-maintainers}

     

       7
       7
       +
       

     

       8
       8
       +
       The options below become available when using `imports = [ (nixpkgs + "/modules/generic/meta-maintainers.nix") ];`.

     

       9
       9
       +
       

     

       10
       10
       +
       ```{=include=} options

     

       11
       11
       +
       id-prefix: opt-modules-generic-meta-maintainers-

     

       12
       12
       +
       list-id: configuration-variable-list

     

       13
       13
       +
       source: ../options-modules-generic-meta-maintainers.json

     

       14
       14
       +
       ```

     

       15
       15
       +
       

     

       16
       16
       +
       [class]: https://nixos.org/manual/nixpkgs/unstable/#module-system-lib-evalModules-param-class

+12

doc/modules/index.md

···

       1
       1
       +
       # Modules {#modules}

     

       2
       2
       +
       

     

       3
       3
       +
       The Nixpkgs repository provides [Module System] modules for various purposes.

     

       4
       4
       +
       

     

       5
       5
       +
       The following sections are organized by [module class].

     

       6
       6
       +
       

     

       7
       7
       +
       ```{=include=} chapters

     

       8
       8
       +
       generic.chapter.md

     

       9
       9
       +
       ```

     

       10
       10
       +
       

     

       11
       11
       +
       [Module System]: https://nixos.org/manual/nixpkgs/unstable/#module-system

     

       12
       12
       +
       [module class]: https://nixos.org/manual/nixpkgs/unstable/#module-system-lib-evalModules-param-class

+9

doc/redirects.json

···

       130
       130
        
         "minor-ghc-deprecation": [

     

       131
       131
        
           "index.html#minor-ghc-deprecation"

     

       132
       132
        
         ],

     

       133
       133
       +
         "modules": [

     

       134
       134
       +
           "index.html#modules"

     

       135
       135
       +
         ],

     

       136
       136
       +
         "modules-generic": [

     

       137
       137
       +
           "index.html#modules-generic"

     

       138
       138
       +
         ],

     

       139
       139
       +
         "modules-generic-meta-maintainers": [

     

       140
       140
       +
           "index.html#modules-generic-meta-maintainers"

     

       141
       141
       +
         ],

     

       133
       142
        
         "neovim": [

     

       134
       143
        
           "index.html#neovim"

     

       135
       144
        
         ],

+9

modules/README.md

···

       1
       1
       +
       # `<nixpkgs>/modules`

     

       2
       2
       +
       

     

       3
       3
       +
       This directory hosts subdirectories representing each module [class](https://nixos.org/manual/nixpkgs/stable/#module-system-lib-evalModules-param-class) for which the `nixpkgs` repository has user-importable modules.

     

       4
       4
       +
       

     

       5
       5
       +
       Exceptions:

     

       6
       6
       +
       - `_class = "nixos";` modules go in the `<nixpkgs>/nixos/modules` tree

     

       7
       7
       +
       - modules whose only purpose is to test code in this repository

     

       8
       8
       +
       

     

       9
       9
       +
       The emphasis is on _importable_ modules, i.e. ones that aren't inherent to and built into the Module System application.

+63

modules/generic/meta-maintainers.nix

···

       1
       1
       +
       # Test:

     

       2
       2
       +
       #   ./meta-maintainers/test.nix

     

       3
       3
       +
       { lib, ... }:

     

       4
       4
       +
       let

     

       5
       5
       +
         inherit (lib)

     

       6
       6
       +
           mkOption

     

       7
       7
       +
           mkOptionType

     

       8
       8
       +
           types

     

       9
       9
       +
           ;

     

       10
       10
       +
       

     

       11
       11
       +
         maintainer = mkOptionType {

     

       12
       12
       +
           name = "maintainer";

     

       13
       13
       +
           check = email: lib.elem email (lib.attrValues lib.maintainers);

     

       14
       14
       +
           merge = loc: defs: {

     

       15
       15
       +
             # lib.last: Perhaps this could be merged instead, if "at most once per module"

     

       16
       16
       +
             # is a problem (see option description).

     

       17
       17
       +
             ${(lib.last defs).file} = (lib.last defs).value;

     

       18
       18
       +
           };

     

       19
       19
       +
         };

     

       20
       20
       +
       

     

       21
       21
       +
         listOfMaintainers = types.listOf maintainer // {

     

       22
       22
       +
           merge =

     

       23
       23
       +
             loc: defs:

     

       24
       24
       +
             lib.zipAttrs (

     

       25
       25
       +
               lib.flatten (

     

       26
       26
       +
                 lib.imap1 (

     

       27
       27
       +
                   n: def:

     

       28
       28
       +
                   lib.imap1 (

     

       29
       29
       +
                     m: def':

     

       30
       30
       +
                     maintainer.merge (loc ++ [ "[${toString n}-${toString m}]" ]) [

     

       31
       31
       +
                       {

     

       32
       32
       +
                         inherit (def) file;

     

       33
       33
       +
                         value = def';

     

       34
       34
       +
                       }

     

       35
       35
       +
                     ]

     

       36
       36
       +
                   ) def.value

     

       37
       37
       +
                 ) defs

     

       38
       38
       +
               )

     

       39
       39
       +
             );

     

       40
       40
       +
         };

     

       41
       41
       +
       in

     

       42
       42
       +
       {

     

       43
       43
       +
         _class = null; # not specific to NixOS

     

       44
       44
       +
         options = {

     

       45
       45
       +
           meta = {

     

       46
       46
       +
             maintainers = mkOption {

     

       47
       47
       +
               type = listOfMaintainers;

     

       48
       48
       +
               default = [ ];

     

       49
       49
       +
               example = lib.literalExpression ''[ lib.maintainers.alice lib.maintainers.bob ]'';

     

       50
       50
       +
               description = ''

     

       51
       51
       +
                 List of maintainers of each module.

     

       52
       52
       +
                 This option should be defined at most once per module.

     

       53
       53
       +
       

     

       54
       54
       +
                 The option value is not a list of maintainers, but an attribute set that maps module file names to lists of maintainers.

     

       55
       55
       +
               '';

     

       56
       56
       +
             };

     

       57
       57
       +
           };

     

       58
       58
       +
         };

     

       59
       59
       +
         meta.maintainers = with lib.maintainers; [

     

       60
       60
       +
           pierron

     

       61
       61
       +
           roberth

     

       62
       62
       +
         ];

     

       63
       63
       +
       }

+34

modules/generic/meta-maintainers/test.nix

···

       1
       1
       +
       # Run:

     

       2
       2
       +
       #   $ nix-instantiate --eval 'modules/generic/meta-maintainers/test.nix'

     

       3
       3
       +
       #

     

       4
       4
       +
       # Expected output:

     

       5
       5
       +
       #   { }

     

       6
       6
       +
       #

     

       7
       7
       +
       # Debugging:

     

       8
       8
       +
       #   drop .test from the end of this file, then use nix repl on it

     

       9
       9
       +
       rec {

     

       10
       10
       +
         lib = import ../../../lib;

     

       11
       11
       +
       

     

       12
       12
       +
         example = lib.evalModules {

     

       13
       13
       +
           modules = [

     

       14
       14
       +
             ../meta-maintainers.nix

     

       15
       15
       +
             {

     

       16
       16
       +
               _file = "eelco.nix";

     

       17
       17
       +
               meta.maintainers = [ lib.maintainers.eelco ];

     

       18
       18
       +
             }

     

       19
       19
       +
           ];

     

       20
       20
       +
         };

     

       21
       21
       +
       

     

       22
       22
       +
         test =

     

       23
       23
       +
           assert

     

       24
       24
       +
             example.config.meta.maintainers == {

     

       25
       25
       +
               ${toString ../meta-maintainers.nix} = [

     

       26
       26
       +
                 lib.maintainers.pierron

     

       27
       27
       +
                 lib.maintainers.roberth

     

       28
       28
       +
               ];

     

       29
       29
       +
               "eelco.nix" = [ lib.maintainers.eelco ];

     

       30
       30
       +
             };

     

       31
       31
       +
           { };

     

       32
       32
       +
       

     

       33
       33
       +
       }

     

       34
       34
       +
       .test

+1

nixos/lib/eval-cacheable-options.nix

···

       49
       49
        
           version = release;

     

       50
       50
        
           revision = "release-${release}";

     

       51
       51
        
           prefix = modulesPath;

     

       52
       52
       +
           extraSources = [ (dirOf nixosPath) ];

     

       52
       53
        
         };

     

       53
       54
        
       in

     

       54
       55
        
       docs.optionsNix

+18 -2

nixos/modules/misc/documentation.nix

···

       116
       116
        
                 && (t == "directory" -> baseNameOf n != "tests")

     

       117
       117
        
                 && (t == "file" -> hasSuffix ".nix" n)

     

       118
       118
        
               );

     

       119
       119
       +
               prefixRegex = "^" + lib.strings.escapeRegex (toString pkgs.path) + "($|/(modules|nixos)($|/.*))";

     

       120
       120
       +
               filteredModules = builtins.path {

     

       121
       121
       +
                 name = "source";

     

       122
       122
       +
                 inherit (pkgs) path;

     

       123
       123
       +
                 filter =

     

       124
       124
       +
                   n: t:

     

       125
       125
       +
                   builtins.match prefixRegex n != null

     

       126
       126
       +
                   && cleanSourceFilter n t

     

       127
       127
       +
                   && (t == "directory" -> baseNameOf n != "tests")

     

       128
       128
       +
                   && (t == "file" -> hasSuffix ".nix" n);

     

       129
       129
       +
               };

     

       119
       130
        
             in

     

       120
       131
        
             pkgs.runCommand "lazy-options.json"

     

       121
       121
       -
               {

     

       132
       132
       +
               rec {

     

       122
       133
        
                 libPath = filter (pkgs.path + "/lib");

     

       123
       134
        
                 pkgsLibPath = filter (pkgs.path + "/pkgs/pkgs-lib");

     

       124
       124
       -
                 nixosPath = filter (pkgs.path + "/nixos");

     

       135
       135
       +
                 nixosPath = filteredModules + "/nixos";

     

       125
       136
        
                 NIX_ABORT_ON_WARN = warningsAreErrors;

     

       126
       137
        
                 modules =

     

       127
       138
        
                   "[ "

     

       128
       139
        
                   + concatMapStringsSep " " (p: ''"${removePrefix "${modulesPath}/" (toString p)}"'') docModules.lazy

     

       129
       140
        
                   + " ]";

     

       130
       141
        
                 passAsFile = [ "modules" ];

     

       142
       142
       +
                 disallowedReferences = [

     

       143
       143
       +
                   filteredModules

     

       144
       144
       +
                   libPath

     

       145
       145
       +
                   pkgsLibPath

     

       146
       146
       +
                 ];

     

       131
       147
        
               }

     

       132
       148
        
               ''

     

       133
       149
        
                 export NIX_STORE_DIR=$TMPDIR/store

+6 -46

nixos/modules/misc/meta.nix

···

       1
       1
        
       { lib, ... }:

     

       2
       2
        
       let

     

       3
       3
       -
         maintainer = lib.mkOptionType {

     

       4
       4
       -
           name = "maintainer";

     

       5
       5
       -
           check = email: lib.elem email (lib.attrValues lib.maintainers);

     

       6
       6
       -
           merge =

     

       7
       7
       -
             loc: defs:

     

       8
       8
       -
             lib.listToAttrs (lib.singleton (lib.nameValuePair (lib.last defs).file (lib.last defs).value));

     

       9
       9
       -
         };

     

       10
       10
       -
       

     

       11
       11
       -
         listOfMaintainers = lib.types.listOf maintainer // {

     

       12
       12
       -
           # Returns list of

     

       13
       13
       -
           #   { "module-file" = [

     

       14
       14
       -
           #        "maintainer1 <first@nixos.org>"

     

       15
       15
       -
           #        "maintainer2 <second@nixos.org>" ];

     

       16
       16
       -
           #   }

     

       17
       17
       -
           merge =

     

       18
       18
       -
             loc: defs:

     

       19
       19
       -
             lib.zipAttrs (

     

       20
       20
       -
               lib.flatten (

     

       21
       21
       -
                 lib.imap1 (

     

       22
       22
       -
                   n: def:

     

       23
       23
       -
                   lib.imap1 (

     

       24
       24
       -
                     m: def':

     

       25
       25
       -
                     maintainer.merge (loc ++ [ "[${toString n}-${toString m}]" ]) [

     

       26
       26
       -
                       {

     

       27
       27
       -
                         inherit (def) file;

     

       28
       28
       -
                         value = def';

     

       29
       29
       -
                       }

     

       30
       30
       -
                     ]

     

       31
       31
       -
                   ) def.value

     

       32
       32
       -
                 ) defs

     

       33
       33
       -
               )

     

       34
       34
       -
             );

     

       35
       35
       -
         };

     

       36
       36
       -
       

     

       37
       3
        
         docFile = lib.types.path // {

     

       38
       4
        
           # Returns tuples of

     

       39
       5
        
           #   { file = "module location"; value = <path/to/doc.xml>; }

     
···

       42
       8
        
       in

     

       43
       9
        
       

     

       44
       10
        
       {

     

       11
       11
       +
         imports = [ ../../../modules/generic/meta-maintainers.nix ];

     

       12
       12
       +
       

     

       45
       13
        
         options = {

     

       46
       14
        
           meta = {

     

       47
       15
        
       

     

       48
       48
       -
             maintainers = lib.mkOption {

     

       49
       49
       -
               type = listOfMaintainers;

     

       50
       50
       -
               internal = true;

     

       51
       51
       -
               default = [ ];

     

       52
       52
       -
               example = lib.literalExpression ''[ lib.maintainers.all ]'';

     

       53
       53
       -
               description = ''

     

       54
       54
       -
                 List of maintainers of each module.  This option should be defined at

     

       55
       55
       -
                 most once per module.

     

       56
       56
       -
               '';

     

       57
       57
       -
             };

     

       58
       58
       -
       

     

       59
       16
        
             doc = lib.mkOption {

     

       60
       17
        
               type = docFile;

     

       61
       18
        
               internal = true;

     
···

       84
       41
        
           };

     

       85
       42
        
         };

     

       86
       43
        
       

     

       87
       87
       -
         meta.maintainers = lib.singleton lib.maintainers.pierron;

     

       44
       44
       +
         meta.maintainers = with lib.maintainers; [

     

       45
       45
       +
           pierron

     

       46
       46
       +
           roberth

     

       47
       47
       +
         ];

     

       88
       48
        
       }