From 4687820524450e9ef6ad896cdf5c1fe7c29539bd Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Tue, 8 Oct 2024 10:17:21 +0200
Subject: [PATCH] Document nixos/modules/profiles/nix-builder-vm.nix

---
 nixos/modules/profiles/nix-builder-vm.nix | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/nixos/modules/profiles/nix-builder-vm.nix b/nixos/modules/profiles/nix-builder-vm.nix
index 08b2fce40011..00768b1297ba 100644
--- a/nixos/modules/profiles/nix-builder-vm.nix
+++ b/nixos/modules/profiles/nix-builder-vm.nix
@@ -1,3 +1,11 @@
+/*
+  This profile uses NixOS to create a remote builder VM to build Linux packages,
+  which can be used to build packages for Linux on other operating systems;
+  primarily macOS.
+
+  It contains both the relevant guest settings as well as an installer script
+  that manages it as a QEMU virtual machine on the host.
+ */
 { config, lib, options, ... }:
 
 let