-
Notifications
You must be signed in to change notification settings - Fork 554
Update the "Updating LLVM" documentation #451
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
Conversation
r? @cuviper I've also updated README.md in rust-lang/llvm-project to point to this documentation about updating. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should mention .gitmodules
, otherwise LGTM!
src/codegen/updating-llvm.md
Outdated
5. Build your commit. Make sure you've committed the previous changes to ensure | ||
3. Build the new LLVM in the `rust` repository. To do this you'll want to update | ||
the `src/llvm-project` repository to your branch and the revision you've | ||
created. Make sure you've committed changes to `src/llvm-project` to ensure |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should make sure to update the branch name in .gitmodules
too, as this enables easy git submodules update --remote src/llvm-project
.
src/codegen/updating-llvm.md
Outdated
7. Send a Pull Request to rust-lang/llvm-project to the same branch as before | ||
7. Send a Pull Request to rust-lang/llvm-project to the same branch as before. | ||
Be sure to reference the Rust and/or LLVM issue that you're fixing in the PR | ||
description. | ||
8. Wait for the PR to be merged | ||
9. Send a PR to rust-lang/rust updating the `src/llvm-project` submodule with | ||
your bugfix |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is another place to mention git submodule update --remote src/llvm-project
, assuming the branch name in .gitmodules
is current.
Make sure existing sections are up-to-date and then also add some words about the recent convention we developed for updating LLVM versions with respect to branch naming as well.
dc0b26e
to
5aa935f
Compare
Excellent points, updated! |
Make sure existing sections are up-to-date and then also add some words about the recent convention we developed for updating LLVM versions with respect to branch naming as well.
Make sure existing sections are up-to-date and then also add some words
about the recent convention we developed for updating LLVM versions with
respect to branch naming as well.