rust-analyzer

mirror of https://github.com/rust-lang/rust-analyzer synced 2024-11-15 01:17:27 +00:00

No description

Find a file

bors b651646510 Auto merge of #13676 - fasterthanlime:subtree-fix, r=Veykril Mega-sync from `rust-lang/rust` This essentially implements `@oli-obk's` suggestion here https://github.com/rust-lang/rust-analyzer/pull/13459#issuecomment-1297285607, with `@eddyb's` help. This PR is equivalent to 14 syncs (back and forth) between `rust-lang/rust` and `rust-lang/rust-analyzer`. Working from this list (from bottom to top): ``` (x) `a2a1d9954` ⬆️ rust-analyzer (x) `79923c382` ⬆️ rust-analyzer (x) `c60b1f641` ⬆️ rust-analyzer (x) `8807fc4cc` ⬆️ rust-analyzer (x) `a99a48e78` ⬆️ rust-analyzer (x) `4f55ebbd4` ⬆️ rust-analyzer (x) `f5fde4df4` ⬆️ rust-analyzer (x) `459bbb422` ⬆️ rust-analyzer (x) `65e1dc4d9` ⬆️ rust-analyzer (x) `3e358a682` ⬆️ rust-analyzer (x) `31519bb39` ⬆️ rust-analyzer (x) `8231fee46` ⬆️ rust-analyzer (x) `22c8c9c40` ⬆️ rust-analyzer (x) `9d2cb42a4` ⬆️ rust-analyzer ``` (This listed was assembled by doing a `git subtree push`, which made a branch, and looking at the new commits in that branch, picking only those that were `⬆️ rust-analyzer` commits) We used the following commands to simulate merges in both directions: ```shell TO_MERGE=22c8c9c40 # taken from the list above, bottom to top git merge --no-edit --no-ff $TO_MERGE git merge --no-edit --no-ff $(git -C ../rust log --pretty=format:'%cN \| %s \| %ad => %P' \| rg -m1 -F "$(git show --no-patch --pretty=format:%ad $TO_MERGE)" \| tee /dev/stderr \| rg '.* => \S+ (\S+)$' --replace '$1') ``` We encountered no merge conflicts that Git wasn't able to solve by doing it this way. Here's what the commit graph looks like (as shown in the Git Lens VSCode extension): <img width="1345" alt="image" src="https://user-images.githubusercontent.com/7998310/203984523-7c1a690a-8224-416c-8015-ed6e49667066.png"> This PR closes #13459 ## Does this unbreak `rust->ra` syncs? Yes, here's how we tried: In `rust-analyzer`: * check out `subtree-fix` (this PR's branch) * make a new branch off of it: `git checkout -b subtree-fix-merge-test` * simulate this PR getting merged with `git merge master` In `rust`: * pull latest master * make a new branch: `git checkout -b test-change` * mess with rust-analyzer (I added a comment to `src/tools/rust-analyzer/Cargo.toml`) * commit * run `git subtree push -P src/tools/rust-analyzer ra-local final-sync` (this follows the [Clippy sync guide](https://doc.rust-lang.org/nightly/clippy/development/infrastructure/sync.html)) This created a `final-sync` branch in `rust-analyzer`. In `rust-analyzer`: * `git merge --no-ff final-sync` (this follows the [Clippy sync guide](https://doc.rust-lang.org/nightly/clippy/development/infrastructure/sync.html)) Now `git log` in `rust-analyzer` shows this: ``` commit 460128387e46ddfc2b95921b2d7f6e913a3d2b9f (HEAD -> subtree-fix-merge-test) Merge: 0513fc02a 9ce6a734f Author: Amos Wenger <amoswenger@gmail.com> Date: Fri Nov 25 13:28:24 2022 +0100 Merge branch 'final-sync' into subtree-fix-merge-test commit 0513fc02a08ea9de952983624bd0a00e98044b36 Merge: `38c98d1ff` `6918009fe` Author: Amos Wenger <amoswenger@gmail.com> Date: Fri Nov 25 13:28:02 2022 +0100 Merge branch 'master' into subtree-fix-merge-test commit 9ce6a734f37ef8e53689f1c6f427a9efafe846bd (final-sync) Author: Amos Wenger <amoswenger@gmail.com> Date: Fri Nov 25 13:26:26 2022 +0100 Mess with rust-analyzer just for fun ``` And `git diff 0513fc02a08ea9de952983624bd0a00e98044b36` shows this: ```patch diff --git a/Cargo.toml b/Cargo.toml index 286ef1e7d..c9e24cd19 100644 --- a/Cargo.toml +++ b/Cargo.toml `@@` -32,3 +32,5 `@@` debug = 0 # ungrammar = { path = "../ungrammar" } # salsa = { path = "../salsa" } + +# lol, hi ``` ## Does this unbreak `ra->rust` syncs? Yes, here's how we tried. From `rust`: * `git checkout -b sync-from-ra` * `git subtree pull -P src/tools/rust-analyzer ra-local subtree-fix-merge-test` (this is adapted from the [Clippy sync guide](https://doc.rust-lang.org/nightly/clippy/development/infrastructure/sync.html#performing-the-sync-from-clippy-to-rust-langrust), you would normally use `ra-upstream master` but we're simulating things here) A commit editor pops up, there was no merge conflicts. ## How do we prevent this from happening again? Like `@bjorn3` said in https://github.com/rust-lang/rust-analyzer/pull/13459#issuecomment-1293587848 > Whenever syncing from rust-analyzer -> rust you have to immediately sync the merge commit from rust -> rust-analyzer to prevent merge conflicts in the future. But if we get it wrong again, at least now we have a not-so-painful way to fix it.		2022-11-25 21:27:46 +00:00
.cargo	Add CARGO_WORKSPACE_DIR env var in `.cargo/config.toml`	2022-07-19 13:02:16 +02:00
.github	⬆️ rust-analyzer	2022-11-09 21:49:10 +02:00
.vscode	⬆️ rust-analyzer	2022-08-16 11:24:50 +03:00
assets	Automatically change text color in logo based on dark mode	2022-03-06 23:06:53 +11:00
bench_data	avoid a `&str` to `String` conversion	2022-08-17 04:58:26 +09:00
crates	Auto merge of #13676 - fasterthanlime:subtree-fix, r=Veykril	2022-11-25 21:27:46 +00:00
docs	⬆️ rust-analyzer	2022-11-23 17:24:03 +02:00
editors/code	Auto merge of #13670 - Veykril:derive-helper, r=Veykril	2022-11-24 21:27:32 +00:00
lib	Pin lsp-types	2022-10-25 15:03:35 +03:00
xtask	⬆️ rust-analyzer	2022-11-23 17:24:03 +02:00
.editorconfig	prettier config	2022-05-17 18:12:49 +01:00
.git-blame-ignore-revs	add prettier format commit to ignored revisions	2022-05-17 18:15:51 +01:00
.gitattributes	Fix .gitattributes for test_data	2022-07-24 14:05:35 +02:00
.gitignore	internal: add "Shuffle Crate Graph" command	2021-12-07 16:37:19 +01:00
Cargo.lock	⬆️ rust-analyzer	2022-11-23 17:24:03 +02:00
Cargo.toml	⬆️ rust-analyzer	2022-10-18 09:12:49 +03:00
LICENSE-APACHE	Licenses	2018-01-10 22:47:04 +03:00
LICENSE-MIT	Licenses	2018-01-10 22:47:04 +03:00
PRIVACY.md	Update privacy note	2021-12-23 14:04:15 +02:00
README.md	⬆️ rust-analyzer	2022-08-09 07:23:57 +03:00
rustfmt.toml	Remove forcing \n via rustfmt	2019-11-02 22:19:59 +03:00
triagebot.toml	⬆️ rust-analyzer	2022-11-09 21:49:10 +02:00

README.md

rust-analyzer is a modular compiler frontend for the Rust language. It is a part of a larger rls-2.0 effort to create excellent IDE support for Rust.

Quick Start

https://rust-analyzer.github.io/manual.html#installation

Documentation

If you want to contribute to rust-analyzer or are just curious about how things work under the hood, check the ./docs/dev folder.

If you want to use rust-analyzer's language server with your editor of choice, check the manual folder. It also contains some tips & tricks to help you be more productive when using rust-analyzer.

Security and Privacy

See the corresponding sections of the manual.

Communication

For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:

https://users.rust-lang.org/c/ide/14

For questions about development and implementation, join rust-analyzer working group on Zulip:

https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer

Quick Links

Website: https://rust-analyzer.github.io/
Metrics: https://rust-analyzer.github.io/metrics/
API docs: https://rust-lang.github.io/rust-analyzer/ide/
Changelog: https://rust-analyzer.github.io/thisweek

License

rust-analyzer is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.