nixos/tmp: add a note to useTmpfs on potential issues

2023-03-20 17:27:06 +01:00 · 2023-03-20 17:27:06 +01:00 · 3a5de0e725
parent a5d95ac5fc
commit 3a5de0e725
1 changed files with 5 additions and 0 deletions
--- a/nixos/modules/system/boot/tmp.nix
+++ b/nixos/modules/system/boot/tmp.nix
@ -36,6 +36,11 @@ in
        default = false;
        description = lib.mdDoc ''
           Whether to mount a tmpfs on {file}`/tmp` during boot.
+
+           ::: {.note}
+           Large Nix builds can fail if the mounted tmpfs is not large enough.
+           In such a case either increase the tmpfsSize or disable this option.
+           :::
        '';
      };
    };