From 9fc07bfff9b802c0eb8f002f1085b8e239ad3a26 Mon Sep 17 00:00:00 2001
From: Langston Barrett <langston.barrett@gmail.com>
Date: Thu, 21 Mar 2024 16:59:39 -0400
Subject: [PATCH] crucible-llvm: Document why `LLVMOverride` is now generic
 over `ext`

---
 crucible-llvm/src/Lang/Crucible/LLVM/Intrinsics/Common.hs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/crucible-llvm/src/Lang/Crucible/LLVM/Intrinsics/Common.hs b/crucible-llvm/src/Lang/Crucible/LLVM/Intrinsics/Common.hs
index 7e692c892..3b53bd9cd 100644
--- a/crucible-llvm/src/Lang/Crucible/LLVM/Intrinsics/Common.hs
+++ b/crucible-llvm/src/Lang/Crucible/LLVM/Intrinsics/Common.hs
@@ -83,6 +83,10 @@ import           Lang.Crucible.LLVM.Translation.Types
 
 -- | This type represents an implementation of an LLVM intrinsic function in
 -- Crucible.
+--
+-- This is parameterized over @ext@ so that 'LLVMOverride's can more easily be
+-- reused in the context of other language extensions that are also based on the
+-- LLVM memory model, such as Macaw.
 data LLVMOverride p sym ext args ret =
   LLVMOverride
   { llvmOverride_declare :: L.Declare    -- ^ An LLVM name and signature for this intrinsic