mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-14 00:25:24 +00:00
1d0fc9729d
Many options define their example to be a Nix value without using literalExample. This sometimes gets rendered incorrectly in the manual, causing confusion like in https://github.com/NixOS/nixpkgs/issues/25516 This fixes it by using literalExample for such options. The list of option to fix was determined with this expression: let nixos = import ./nixos { configuration = {}; }; lib = import ./lib; valid = d: { # escapeNixIdentifier from https://github.com/NixOS/nixpkgs/pull/82461 set = lib.all (n: lib.strings.escapeNixIdentifier n == n) (lib.attrNames d) && lib.all (v: valid v) (lib.attrValues d); list = lib.all (v: valid v) d; }.${builtins.typeOf d} or true; optionList = lib.optionAttrSetToDocList nixos.options; in map (opt: { file = lib.elemAt opt.declarations 0; loc = lib.options.showOption opt.loc; }) (lib.filter (opt: if opt ? example then ! valid opt.example else false) optionList) which when evaluated will output all options that use a Nix identifier that would need escaping as an attribute name.
69 lines
1.4 KiB
Nix
69 lines
1.4 KiB
Nix
{ config, lib, pkgs, ...}:
|
|
|
|
with lib;
|
|
{
|
|
imports = [ ./yarn.nix ./hdfs.nix ];
|
|
|
|
options.services.hadoop = {
|
|
coreSite = mkOption {
|
|
default = {};
|
|
example = literalExample ''
|
|
{
|
|
"fs.defaultFS" = "hdfs://localhost";
|
|
}
|
|
'';
|
|
description = "Hadoop core-site.xml definition";
|
|
};
|
|
|
|
hdfsSite = mkOption {
|
|
default = {};
|
|
example = literalExample ''
|
|
{
|
|
"dfs.nameservices" = "namenode1";
|
|
}
|
|
'';
|
|
description = "Hadoop hdfs-site.xml definition";
|
|
};
|
|
|
|
mapredSite = mkOption {
|
|
default = {};
|
|
example = literalExample ''
|
|
{
|
|
"mapreduce.map.cpu.vcores" = "1";
|
|
}
|
|
'';
|
|
description = "Hadoop mapred-site.xml definition";
|
|
};
|
|
|
|
yarnSite = mkOption {
|
|
default = {};
|
|
example = literalExample ''
|
|
{
|
|
"yarn.resourcemanager.ha.id" = "resourcemanager1";
|
|
}
|
|
'';
|
|
description = "Hadoop yarn-site.xml definition";
|
|
};
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.hadoop;
|
|
defaultText = "pkgs.hadoop";
|
|
example = literalExample "pkgs.hadoop";
|
|
description = ''
|
|
'';
|
|
};
|
|
};
|
|
|
|
|
|
config = mkMerge [
|
|
(mkIf (builtins.hasAttr "yarn" config.users.users ||
|
|
builtins.hasAttr "hdfs" config.users.users) {
|
|
users.groups.hadoop = {
|
|
gid = config.ids.gids.hadoop;
|
|
};
|
|
})
|
|
|
|
];
|
|
}
|