Skip to content

[RemoveDIs] Add release note for C API changes #92396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

OCHyams
Copy link
Contributor

@OCHyams OCHyams commented May 16, 2024

The changes have been documented in the migration guide llvm/docs/RemoveDIsDebugInfo.md - add the info to the release notes.

@OCHyams OCHyams requested review from jryans and SLTozer May 16, 2024 12:58
* ``LLVMDIBuilderInsertDeclareRecordBefore``
* ``LLVMDIBuilderInsertDeclareRecordAtEnd``
* ``LLVMDIBuilderInsertDbgValueRecordBefore``
* ``LLVMDIBuilderInsertDbgValueRecordAtEnd``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to remove these prior to the LLVM 19 release? We shouldn't add temporary functions to the C API if we can avoid it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could remove the "InsertDbg...Record" four above without a problem, since these are just aliases for LLVMDIBuilderInsertDeclareBefore and friends (the modified ones below).

It's more difficult to remove the intrinsic based insertion functions, e.g. LLVMDIBuilderInsertDeclareIntrinsicBefore, because these return a different type to the debug record insertion ones.

All of these functions above have been added as a transition aid for projects that aren't ready to move to debug records (the new debug info format). Most projects shouldn't need to use them. For projects ready to use debug intrinsics the only update required would be to address compiler errors introduced by the new return type of the modified functions below.

@OCHyams
Copy link
Contributor Author

OCHyams commented Jul 1, 2024

Closing as the docs updates were handled by @CarlosAlbertoEnciso in #95535

@OCHyams OCHyams closed this Jul 1, 2024
@OCHyams OCHyams deleted the c-api-rel-notes branch July 1, 2024 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants