From 3a5de0e7258d249a36fc29f0bb2a55f40b211a45 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sandro=20J=C3=A4ckel?= <sandro.jaeckel@sap.com>
Date: Mon, 20 Mar 2023 17:27:06 +0100
Subject: [PATCH] nixos/tmp: add a note to useTmpfs on potential issues

---
 nixos/modules/system/boot/tmp.nix | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/nixos/modules/system/boot/tmp.nix b/nixos/modules/system/boot/tmp.nix
index 3775f17d763..fd16cd3fba4 100644
--- 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.
+           :::
         '';
       };
     };