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. |
||
|---|---|---|
| .. | ||
| automysqlbackup.nix | ||
| bacula.nix | ||
| borgbackup.nix | ||
| duplicati.nix | ||
| duplicity.nix | ||
| mysql-backup.nix | ||
| postgresql-backup.nix | ||
| postgresql-wal-receiver.nix | ||
| restic-rest-server.nix | ||
| restic.nix | ||
| rsnapshot.nix | ||
| sanoid.nix | ||
| syncoid.nix | ||
| tarsnap.nix | ||
| tsm.nix | ||
| zfs-replication.nix | ||
| znapzend.nix | ||