Restore LLVMLinkModules C API until it is properly deprecated.
[oota-llvm.git] / include / llvm-c / Linker.h
index cedde5ea8e3aa0af4ce35fd58a2121e3f4525cfb..9f98a3342d0bfc351aeb1b792c030d2b96f48af9 100644 (file)
 extern "C" {
 #endif
 
+/* This enum is provided for backwards-compatibility only. It has no effect. */
+typedef enum {
+  LLVMLinkerDestroySource = 0, /* This is the default behavior. */
+  LLVMLinkerPreserveSource_Removed = 1 /* This option has been deprecated and
+                                          should not be used. */
+} LLVMLinkerMode;
+
 /* Links the source module into the destination module, taking ownership
  * of the source module away from the caller. Optionally returns a
  * human-readable description of any errors that occurred in linking.
  * OutMessage must be disposed with LLVMDisposeMessage. The return value
- * is true if an error occurred, false otherwise. */
+ * is true if an error occurred, false otherwise.
+ *
+ * Note that the linker mode parameter \p Unused is no longer used, and has
+ * no effect. */
 LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src,
-                         unsigned Unused, char **OutMessage);
+                         LLVMLinkerMode Unused, char **OutMessage);
 
 #ifdef __cplusplus
 }