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.

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

docs: describe LLVM IR generation features #69

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Conversation

wzmuda
Copy link
Contributor

@wzmuda wzmuda commented Oct 2, 2024

Summary

Add results of the research done in #28.

Details

This is more polished version of my notes posted before in the task comments.

Checklist

- [ ] Code is formatted by Rustfmt.

  • Documentation has been updated if necessary.

@wzmuda wzmuda requested a review from a team as a code owner October 2, 2024 14:11
Copy link
Collaborator

@iamrecursion iamrecursion left a comment

Choose a reason for hiding this comment

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

Awesome stuff, just a couple of minor nits!

@@ -0,0 +1,132 @@
````markdown
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
````markdown

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@@ -0,0 +1,132 @@
````markdown
# LLVM IR generation features
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# LLVM IR generation features
# LLVM IR Generation Features

Headings should use title case!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed along with the file name

Comment on lines 7 to 8
executable binary. The `rustc` compiler first picks up the Rust code file and then generates an
intermediate representation known as LLVM IR. LLVM, then performs multiple optimization and
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is technically skipping over the HIR and MIR phases, but I think that's fine for this.

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 added a sentence about that just to make sure I don't introduce any confusion

wzmuda added 2 commits October 3, 2024 00:26
Signed-off-by: Wojciech Zmuda <[email protected]>
@wzmuda wzmuda force-pushed the wz/llvm-features-research branch from 2cd2581 to cdbf120 Compare October 2, 2024 22:40
@wzmuda wzmuda merged commit a7ce0fd into main Oct 3, 2024
4 checks passed
@wzmuda wzmuda deleted the wz/llvm-features-research branch October 3, 2024 19:41
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