ilyakooo0/nixpkgs
1
0
Fork 0
mirror of https://github.com/ilyakooo0/nixpkgs.git synced 2024-11-12 03:56:17 +03:00
Code Issues Projects Releases Wiki Activity

doc/option-types: Make attrTag example self-contained

Browse Source 
... well, except for the ellipses, which hide unnecessary descriptions,
which you should write!
This commit is contained in:
Robert Hensing 2024-02-04 17:17:47 +01:00
parent c0f54d3dea
commit fa8b46adf4
1 changed files with 32 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
nixos/doc/manual/development/option-types.section.md
View File

@ -323,22 +323,40 @@ If the built-in Nix value types provide enough distinction, you simplify your sy
Example:
```nix
types.attrTag {
bounce = mkOption {
description = "Send back a packet explaining why it wasn't forwarded.";
type = submodule {
options.errorMessage = mkOption { … };
};
{ lib, ... }:
let inherit (lib) type mkOption;
in {
options.toyRouter.rules = mkOption {
description = ''
Rules for a fictional packet routing service.
'';
type = types.attrsOf (
types.attrTag {
bounce = mkOption {
description = "Send back a packet explaining why it wasn't forwarded.";
type = types.submodule {
options.errorMessage = mkOption { … };
};
};
forward = mkOption {
description = "Forward the packet.";
type = types.submodule {
options.destination = mkOption { … };
};
};
ignore = types.mkOption {
description = "Drop the packet without sending anything back.";
type = types.submodule {};
};
});
};
forward = mkOption {
description = "Forward the packet.";
type = submodule {
options.destination = mkOption { … };
config.toyRouter.rules = {
http = {
bounce = {
errorMessage = "Unencrypted HTTP is banned. You must always use https://.";
};
};
};
ignore = mkOption {
description = "Drop the packet without sending anything back.";
type = submodule {};
ssh = { drop = {}; };
};
}
```