Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Deprecate llvm_struct() #2159

Open
sauclovian-g opened this issue Dec 12, 2024 · 0 comments
Open

Deprecate llvm_struct() #2159

sauclovian-g opened this issue Dec 12, 2024 · 0 comments
Labels
better-when-documented Issues whose root causes include missing or wrong documentation documentation Issues involving documentation easy Issues that are expected to be easy to resolve and might therefore be good for new contributors subsystem: crucible-llvm Issues related to LLVM bitcode verification with crucible-llvm tech debt Issues that document or involve technical debt type: bug Issues reporting bugs or unexpected/unwanted behavior usability An issue that impedes efficient understanding and use
Milestone
2024T3

Comments

@sauclovian-g
Copy link
Contributor

The builtin llvm_struct looks up a type alias by name. However, it's easily mistaken for llvm_struct_type (which constructs a struct type from a list of fields) and was therefore replaced with llvm_alias.

llvm_struct is however still there to cause confusion. It should get marked deprecated.

One of the pieces of such confusion is that it appears in the manual where llvm_struct_type should have been used.
@sauclovian-g sauclovian-g added type: bug Issues reporting bugs or unexpected/unwanted behavior documentation Issues involving documentation easy Issues that are expected to be easy to resolve and might therefore be good for new contributors subsystem: crucible-llvm Issues related to LLVM bitcode verification with crucible-llvm usability An issue that impedes efficient understanding and use tech debt Issues that document or involve technical debt better-when-documented Issues whose root causes include missing or wrong documentation labels Dec 12, 2024
@sauclovian-g sauclovian-g added this to the 2024T3 milestone Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
better-when-documented Issues whose root causes include missing or wrong documentation documentation Issues involving documentation easy Issues that are expected to be easy to resolve and might therefore be good for new contributors subsystem: crucible-llvm Issues related to LLVM bitcode verification with crucible-llvm tech debt Issues that document or involve technical debt type: bug Issues reporting bugs or unexpected/unwanted behavior usability An issue that impedes efficient understanding and use
Projects
None yet
Milestone
2024T3
Development

No branches or pull requests
1 participant
@sauclovian-g