Skip to content

Commit 197ab57

Browse files
committed
add C API info to the docs
1 parent 63511e0 commit 197ab57

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

llvm/docs/RemoveDIsDebugInfo.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,22 @@ There are two significant changes to be aware of. Firstly, we're adding a single
3030

3131
The second matter is that if you transfer sequences of instructions from one place to another manually, i.e. repeatedly using `moveBefore` where you might have used `splice`, then you should instead use the method `moveBeforePreserving`. `moveBeforePreserving` will transfer debug info records with the instruction they're attached to. This is something that happens automatically today -- if you use `moveBefore` on every element of an instruction sequence, then debug intrinsics will be moved in the normal course of your code, but we lose this behaviour with non-instruction debug info.
3232

33+
# C-API changes
34+
35+
```
36+
LLVMDIBuilderInsertDeclareBefore # Changed - Inserts a non-instruction debug record.
37+
LLVMDIBuilderInsertDeclareAtEnd # Changed - Inserts a non-instruction debug record.
38+
LLVMDIBuilderInsertDbgValueBefore # Changed - Inserts a non-instruction debug record.
39+
LLVMDIBuilderInsertDbgValueAtEnd # Changed - Inserts a non-instruction debug record.
40+
41+
LLVMIsNewDbgInfoFormat # New - Returns true if the module is in the new non-instruction mode. Will be deprecated in future.
42+
LLVMDIBuilderInsertDeclareIntrinsicBefore # New - Old behaviour of the changed functions above, i.e., insert a dbg intrinsic call. Will be deprecated in future.
43+
LLVMDIBuilderInsertDeclareIntrinsicAtEnd # New - Old behaviour of the changed functions above, i.e., insert a dbg intrinsic call. Will be deprecated in future.
44+
LLVMDIBuilderInsertDbgValueIntrinsicBefore # New - Old behaviour of the changed functions above, i.e., insert a dbg intrinsic call. Will be deprecated in future.
45+
LLVMDIBuilderInsertDbgValueIntrinsicAtEnd # New - Old behaviour of the changed functions above, i.e., insert a dbg intrinsic call. Will be deprecated in future.
46+
```
47+
48+
3349
# Anything else?
3450

3551
Not really, but here's an "old vs new" comparison of how to do certain things and quickstart for how this "new" debug info is structured.

0 commit comments

Comments
 (0)