From 4bc773964ae3c48b806fc2ad30dd5811571d902a Mon Sep 17 00:00:00 2001
From: colin <colin@cicadas.surf>
Date: Sat, 1 Jun 2024 11:38:12 -0700
Subject: Add: note about why we append _ to some instr class names

---
 src/instr.lisp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/instr.lisp b/src/instr.lisp
index db13941..fe80ecb 100644
--- a/src/instr.lisp
+++ b/src/instr.lisp
@@ -18,6 +18,10 @@
     (defun expand-instr-plist (plist)
       (destructuring-bind (&key instr code type) plist
         (let* ((class-name
+                 ;; `select` names two instructions, so we add this
+                 ;; machinery to check for two instructions with the
+                 ;; same name, and to append `_` to the class name
+                 ;; whenever name collision is detected
                  (let ((class-name (intern (string-upcase (first instr)))))
                    (cl:if (gethash class-name defined)
                           (intern (format nil "~a_" class-name))
-- 
cgit v1.2.3