summary refs log tree commit diff
path: root/nixos/modules/services/networking/hostapd.nix
diff options
context:
space:
mode:
authorSilvan Mosberger <contact@infinisil.com>2020-04-02 07:39:04 +0200
committerSilvan Mosberger <contact@infinisil.com>2020-04-02 07:49:25 +0200
commit1d0fc9729dd8564dc75b5fd020da6bd61e0346c0 (patch)
tree10ee602ed08d5ace4f98cf310cd78fca7e098d0d /nixos/modules/services/networking/hostapd.nix
parentf75c11cfdfff3448623250e151cb47df70d4f224 (diff)
downloadnixpkgs-1d0fc9729dd8564dc75b5fd020da6bd61e0346c0.tar
nixpkgs-1d0fc9729dd8564dc75b5fd020da6bd61e0346c0.tar.gz
nixpkgs-1d0fc9729dd8564dc75b5fd020da6bd61e0346c0.tar.bz2
nixpkgs-1d0fc9729dd8564dc75b5fd020da6bd61e0346c0.tar.lz
nixpkgs-1d0fc9729dd8564dc75b5fd020da6bd61e0346c0.tar.xz
nixpkgs-1d0fc9729dd8564dc75b5fd020da6bd61e0346c0.tar.zst
nixpkgs-1d0fc9729dd8564dc75b5fd020da6bd61e0346c0.zip
nixos/treewide: Fix incorrectly rendered examples
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.
Diffstat (limited to 'nixos/modules/services/networking/hostapd.nix')
0 files changed, 0 insertions, 0 deletions