From 622f6046c72c448ade12f0b7fb40d81c7131850a Mon Sep 17 00:00:00 2001
From: Martin Wimpress <martin@wimpress.org>
Date: Mon, 13 May 2024 10:06:20 +0100
Subject: [PATCH] docs: add comments for the main VM variables

---
 quickemu | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/quickemu b/quickemu
index 2f1e056..04c64c4 100755
--- a/quickemu
+++ b/quickemu
@@ -1722,9 +1722,9 @@ if [ -n "${VM}" ] && [ -e "${VM}" ]; then
     # shellcheck source=/dev/null
     source "${VM}"
 
-    VMDIR=$(dirname "${disk_img}")
-    VMNAME=$(basename "${VM}" .conf)
-    VMPATH=$(realpath "$(dirname "${VM}")")
+    VMDIR=$(dirname "${disk_img}")          # directory the VM disk and state files are stored
+    VMNAME=$(basename "${VM}" .conf)        # name of the VM
+    VMPATH=$(realpath "$(dirname "${VM}")") # path to the top-level VM directory
     SOCKET_MONITOR="${VMDIR}/${VMNAME}-monitor.socket"
     SOCKET_SERIAL="${VMDIR}/${VMNAME}-serial.socket"