Merge #12357: nixos docs: show references to packages

+37 -27
+1 -1
lib/attrsets.nix
··· 207 208 209 /* Like `mapAttrsRecursive', but it takes an additional predicate 210 - function that tells it whether to recursive into an attribute 211 set. If it returns false, `mapAttrsRecursiveCond' does not 212 recurse, but does apply the map function. It is returns true, it 213 does recurse, and does not apply the map function.
··· 207 208 209 /* Like `mapAttrsRecursive', but it takes an additional predicate 210 + function that tells it whether to recurse into an attribute 211 set. If it returns false, `mapAttrsRecursiveCond' does not 212 recurse, but does apply the map function. It is returns true, it 213 does recurse, and does not apply the map function.
+1 -2
nixos/modules/programs/ssh.nix
··· 36 37 askPassword = mkOption { 38 type = types.str; 39 description = ''Program used by SSH to ask for passwords.''; 40 }; 41 ··· 225 ''; 226 227 environment.variables.SSH_ASKPASS = optionalString config.services.xserver.enable askPassword; 228 - 229 - programs.ssh.askPassword = mkDefault "${pkgs.x11_ssh_askpass}/libexec/x11-ssh-askpass"; 230 231 }; 232 }
··· 36 37 askPassword = mkOption { 38 type = types.str; 39 + default = "${pkgs.x11_ssh_askpass}/libexec/x11-ssh-askpass"; 40 description = ''Program used by SSH to ask for passwords.''; 41 }; 42 ··· 226 ''; 227 228 environment.variables.SSH_ASKPASS = optionalString config.services.xserver.enable askPassword; 229 230 }; 231 }
+1 -2
nixos/modules/programs/venus.nix
··· 99 }; 100 101 outputTheme = mkOption { 102 type = types.path; 103 description = '' 104 Directory containing a config.ini file which is merged with this one. ··· 168 environment.SSL_CERT_FILE = "/etc/ssl/certs/ca-certificates.crt"; 169 startAt = cfg.dates; 170 }; 171 - 172 - services.venus.outputTheme = mkDefault "${pkgs.venus}/themes/classic_fancy"; 173 174 }; 175 }
··· 99 }; 100 101 outputTheme = mkOption { 102 + default = "${pkgs.venus}/themes/classic_fancy"; 103 type = types.path; 104 description = '' 105 Directory containing a config.ini file which is merged with this one. ··· 169 environment.SSL_CERT_FILE = "/etc/ssl/certs/ca-certificates.crt"; 170 startAt = cfg.dates; 171 }; 172 173 }; 174 }
+1 -2
nixos/modules/services/amqp/activemq/default.nix
··· 32 ''; 33 }; 34 configurationDir = mkOption { 35 description = '' 36 The base directory for ActiveMQ's configuration. 37 By default, this directory is searched for a file named activemq.xml, ··· 124 ${cfg.extraJavaOptions} ActiveMQBroker "${cfg.configurationURI}" 125 ''; 126 }; 127 - 128 - services.activemq.configurationDir = mkDefault "${activemq}/conf"; 129 130 }; 131
··· 32 ''; 33 }; 34 configurationDir = mkOption { 35 + default = "${activemq}/conf"; 36 description = '' 37 The base directory for ActiveMQ's configuration. 38 By default, this directory is searched for a file named activemq.xml, ··· 125 ${cfg.extraJavaOptions} ActiveMQBroker "${cfg.configurationURI}" 126 ''; 127 }; 128 129 }; 130
+1 -2
nixos/modules/services/misc/nixos-manual.nix
··· 80 81 services.nixosManual.browser = mkOption { 82 type = types.path; 83 description = '' 84 Browser used to show the manual. 85 ''; ··· 116 117 services.mingetty.helpLine = mkIf cfg.showManual 118 "\nPress <Alt-F${toString cfg.ttyNumber}> for the NixOS manual."; 119 - 120 - services.nixosManual.browser = mkDefault "${pkgs.w3m-nox}/bin/w3m"; 121 122 }; 123
··· 80 81 services.nixosManual.browser = mkOption { 82 type = types.path; 83 + default = "${pkgs.w3m-nox}/bin/w3m"; 84 description = '' 85 Browser used to show the manual. 86 ''; ··· 117 118 services.mingetty.helpLine = mkIf cfg.showManual 119 "\nPress <Alt-F${toString cfg.ttyNumber}> for the NixOS manual."; 120 121 }; 122
+1 -3
nixos/modules/services/misc/subsonic.nix
··· 97 98 transcoders = mkOption { 99 type = types.listOf types.path; 100 description = '' 101 List of paths to transcoder executables that should be accessible 102 from Subsonic. Symlinks will be created to each executable inside ··· 152 }; 153 154 users.extraGroups.subsonic.gid = config.ids.gids.subsonic; 155 - 156 - services.subsonic.transcoders = mkDefault [ "${pkgs.ffmpeg}/bin/ffmpeg" ]; 157 - 158 }; 159 }
··· 97 98 transcoders = mkOption { 99 type = types.listOf types.path; 100 + default = [ "${pkgs.ffmpeg}/bin/ffmpeg" ]; 101 description = '' 102 List of paths to transcoder executables that should be accessible 103 from Subsonic. Symlinks will be created to each executable inside ··· 153 }; 154 155 users.extraGroups.subsonic.gid = config.ids.gids.subsonic; 156 }; 157 }
+1 -3
nixos/modules/services/monitoring/grafana.nix
··· 87 88 staticRootPath = mkOption { 89 description = "Root path for static assets."; 90 type = types.str; 91 }; 92 ··· 232 home = cfg.dataDir; 233 createHome = true; 234 }; 235 - 236 - services.grafana.staticRootPath = mkDefault "${cfg.package}/share/grafana/public"; 237 - 238 }; 239 }
··· 87 88 staticRootPath = mkOption { 89 description = "Root path for static assets."; 90 + default = "${cfg.package.out}/share/grafana/public"; 91 type = types.str; 92 }; 93 ··· 233 home = cfg.dataDir; 234 createHome = true; 235 }; 236 }; 237 }
+4 -1
nixos/modules/services/networking/dnscrypt-proxy.nix
··· 52 default = "opendns"; 53 type = types.nullOr types.string; 54 description = '' 55 - The name of the upstream DNSCrypt resolver to use. 56 ''; 57 }; 58 customResolver = mkOption {
··· 52 default = "opendns"; 53 type = types.nullOr types.string; 54 description = '' 55 + The name of the upstream DNSCrypt resolver to use. See 56 + <literal>${resolverListFile}</literal> for alternative resolvers 57 + (e.g., if you are concerned about logging and/or server 58 + location). 59 ''; 60 }; 61 customResolver = mkOption {
+2 -3
nixos/modules/services/web-servers/phpfpm.nix
··· 46 47 phpIni = mkOption { 48 type = types.path; 49 - description = "PHP configuration file to use."; 50 }; 51 52 poolConfigs = mkOption { ··· 86 PIDFile = pidFile; 87 }; 88 }; 89 - 90 - services.phpfpm.phpIni = mkDefault "${cfg.phpPackage}/etc/php-recommended.ini"; 91 92 }; 93 }
··· 46 47 phpIni = mkOption { 48 type = types.path; 49 + default = "${cfg.phpPackage}/etc/php-recommended.ini"; 50 + description = "php.ini file to use."; 51 }; 52 53 poolConfigs = mkOption { ··· 87 PIDFile = pidFile; 88 }; 89 }; 90 91 }; 92 }
+1 -3
nixos/modules/services/x11/display-managers/lightdm.nix
··· 87 88 background = mkOption { 89 type = types.str; 90 description = '' 91 The background image or color to use. 92 ''; ··· 152 }; 153 154 users.extraGroups.lightdm.gid = config.ids.gids.lightdm; 155 - 156 - services.xserver.displayManager.lightdm.background = mkDefault "${pkgs.nixos-artwork}/share/artwork/gnome/Gnome_Dark.png"; 157 - 158 services.xserver.tty = null; # We might start multiple X servers so let the tty increment themselves.. 159 services.xserver.display = null; # We specify our own display (and logfile) in xserver-wrapper up there 160 };
··· 87 88 background = mkOption { 89 type = types.str; 90 + default = "${pkgs.nixos-artwork}/share/artwork/gnome/Gnome_Dark.png"; 91 description = '' 92 The background image or color to use. 93 ''; ··· 153 }; 154 155 users.extraGroups.lightdm.gid = config.ids.gids.lightdm; 156 services.xserver.tty = null; # We might start multiple X servers so let the tty increment themselves.. 157 services.xserver.display = null; # We specify our own display (and logfile) in xserver-wrapper up there 158 };
+23 -5
nixos/release.nix
··· 92 }).config)); 93 94 95 in rec { 96 97 channel = import lib/make-channel.nix { inherit pkgs nixpkgs version versionSuffix; }; 98 99 - manual = buildFromConfig ({ pkgs, ... }: { }) (config: config.system.build.manual.manual); 100 - manualPDF = (buildFromConfig ({ pkgs, ... }: { }) (config: config.system.build.manual.manualPDF)).x86_64-linux; 101 - manpages = buildFromConfig ({ pkgs, ... }: { }) (config: config.system.build.manual.manpages); 102 - options = (buildFromConfig ({ pkgs, ... }: { }) (config: config.system.build.manual.optionsJSON)).x86_64-linux; 103 - 104 105 # Build the initial ramdisk so Hydra can keep track of its size over time. 106 initialRamdisk = buildFromConfig ({ pkgs, ... }: { }) (config: config.system.build.initialRamdisk);
··· 92 }).config)); 93 94 95 + cleanConfig = import ./lib/eval-config.nix { 96 + system = "x86_64-linux"; 97 + modules = [ ]; 98 + pkgs = with pkgs.lib; 99 + let 100 + scrubDerivations = namePrefix: pkgSet: mapAttrs 101 + (name: value: 102 + let wholeName = "${namePrefix}.${name}"; in 103 + if isAttrs value then 104 + scrubDerivations wholeName value 105 + // (optionalAttrs (isDerivation value) { outPath = "\${${wholeName}}"; }) 106 + else value 107 + ) 108 + pkgSet; 109 + in scrubDerivations "pkgs" pkgs; 110 + }; 111 + docs = (import ./doc/manual) { 112 + inherit pkgs version; 113 + revision = versionModule.system.nixosRevision; 114 + inherit (cleanConfig) options; 115 + }; 116 + 117 in rec { 118 119 channel = import lib/make-channel.nix { inherit pkgs nixpkgs version versionSuffix; }; 120 121 + inherit (docs) manual manualPDF manpages optionsJSON; 122 123 # Build the initial ramdisk so Hydra can keep track of its size over time. 124 initialRamdisk = buildFromConfig ({ pkgs, ... }: { }) (config: config.system.build.initialRamdisk);