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

Add help for when you update a submodule by accident #1537

Merged
merged 2 commits into from Jan 1, 2023

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Dec 31, 2022

Ideally, I think the instructions to fix this would be a standalone tool you could run automatically. This seems like a good intermediate step, though.

@jyn514 jyn514 changed the title Give help for when you update a submodule by accident Add help for when you update a submodule by accident Dec 31, 2022
@jyn514 jyn514 force-pushed the submodule-help branch 2 times, most recently from 374c092 to 8257749 Compare December 31, 2022 21:14
src/git.md Outdated Show resolved Hide resolved
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
@jyn514 jyn514 merged commit b3e2a6e into rust-lang:master Jan 1, 2023
@jyn514 jyn514 deleted the submodule-help branch January 1, 2023 05:20
compiler-errors added a commit to compiler-errors/rust that referenced this pull request Jan 2, 2023
Update books

## rust-lang/book

3 commits in a60f4316ec923a5ac2ed6a2eba6960edb832d855..2bd5d42c9956369132228da6409f0e68da56c51a
2022-12-22 21:37:10 UTC to 2022-12-22 21:36:14 UTC

- fix macos installation problem (rust-lang/book#3469)
- Update -guessing-game-tutorial incorrect output (rust-lang/book#3462)
- FIX: IT repo updated (rust-lang/book#3454)

## rust-lang/nomicon

1 commits in dd37e21ccee43918ed18a71581bb2af537ffe4fc..8ca261268068d80c0969260fff15199bad87b587
2022-12-30 16:32:09 UTC to 2022-12-30 16:32:09 UTC

- Discourage the use of transmute to construct invalid values (rust-lang/nomicon#388)

## rust-lang/rust-by-example

6 commits in 995df09b65c582eb6290ab7ea5d9485983eb4c37..8888f9428fe9a48f31de6bd2cef9b9bf80791edc
2023-01-01 12:53:50 UTC to 2022-12-21 10:18:31 UTC

- types/alias: use io::{Result,Error} instead of Io{Result,Error} (rust-lang/rust-by-example#1660)
- Fix sample code mismatching its comments (rust-lang/rust-by-example#1659)
- fix: add missing space (rust-lang/rust-by-example#1658)
- diverging: fix issues with example code (rust-lang/rust-by-example#1631)
- Update enum.md (rust-lang/rust-by-example#1645)
- Clean up Chapter 2 (Primitives) (rust-lang/rust-by-example#1651)

## rust-lang/rustc-dev-guide

5 commits in 8b42eb5f57d3d8ed2257a22d0e850d9db52afed3..b3e2a6e6c8a3aae5b5d950c63046f23bae07096d
2023-01-01 05:20:47 UTC to 2022-12-25 12:11:21 UTC

- Add help for when you update a submodule by accident (rust-lang/rustc-dev-guide#1537)
- Simplify "how to build and run" section (rust-lang/rustc-dev-guide#1528)
- Replace `$TARGET` with `host` (rust-lang/rustc-dev-guide#1514)
- Add more rebasing help (rust-lang/rustc-dev-guide#1536)
- Fix rustc_borrowck crate name typo (rust-lang/rustc-dev-guide#1535)

You might also notice conflicts in the web UI:

![conflict in src/tools/cargo](./img/submodule-conflicts.png)
Copy link
Member

@chenyukang chenyukang Jan 6, 2023

Choose a reason for hiding this comment

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

@jyn514
I was annoyed by this for some time, now I use this justfile for just to rebase or sync master:

old_branch := `git rev-parse --abbrev-ref HEAD`
rebm:
        git stash
        git checkout up-master
        git pull
        git submodule sync
        git submodule update
        git stash
        git checkout {{old_branch}}
        git rebase up-master

sync:
        git stash
        git checkout up-master
        git pull
        git submodule sync
        git submodule update

Then only run j rebm to to rebase master.
I'm not sure whether we can provide some handy functions to help developers, but I'm sure for those devs who don't touch submodules, it will save a lot of time to fix submodule conflicts.

Copy link
Member Author

Choose a reason for hiding this comment

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

Leaving comments on closed PRs is not a good way to contact me, I have too many github notifications to read them all.

It sounds like you have a suggestion to improve this section :) feel free to open either an issue or a PR.

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.

None yet

4 participants