Mark llvm_struct deprecated. Add changelog entry.

GaloisInc · Jan 22, 2025 · 0faef8f · 0faef8f
1 parent 7894700
commit 0faef8f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/CHANGES.md b/CHANGES.md
@@ -9,6 +9,13 @@
 * Add `mir_equal` and `jvm_equal` commands, which mirror the `llvm_equal`
   command for the MIR and JVM backends, respectively.
 
+## Deprecations
+
+* `llvm_struct` has been marked deprecated.
+It is the same as `llvm_alias` and you should use this instead.
+(If you were looking for a function to create a struct type from its
+contents, that's `llvm_struct_type`.)
+
 ## Bug fixes
 
 * SAW now accepts Unicode input beyond characters 0..255, including in

diff --git a/src/SAWScript/Interpreter.hs b/src/SAWScript/Interpreter.hs
@@ -2773,8 +2773,9 @@ primitives = Map.fromList
     ]
   , prim "llvm_struct"         "String -> LLVMType"
     (pureVal llvm_alias)
-    Current
+    Deprecated
     [ "Legacy alternative name for `llvm_alias`."
+    , "If you are trying to cons a struct type by its contents, you want llvm_struct_type."
     ]
 
   , prim "llvm_pointer"        "LLVMType -> LLVMType"