diff options
| author | Jakub Beránek <berykubik@gmail.com> | 2025-07-22 18:14:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-07-22 18:14:20 +0200 |
| commit | 0c22e6123be4b40947be3aa25e2e8c0dbe4d51cc (patch) | |
| tree | 0a763eca84273aa7c332a27d7251606db7716e4d | |
| parent | 75a1a04a352d35aa584bef2bc1a9b4fd591f3cca (diff) | |
| download | rust-0c22e6123be4b40947be3aa25e2e8c0dbe4d51cc.tar.gz rust-0c22e6123be4b40947be3aa25e2e8c0dbe4d51cc.zip | |
Apply suggestions from code review
Co-authored-by: Laurențiu Nicola <lnicola@users.noreply.github.com>
| -rw-r--r-- | src/tools/rust-analyzer/docs/book/src/contributing/README.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/tools/rust-analyzer/docs/book/src/contributing/README.md b/src/tools/rust-analyzer/docs/book/src/contributing/README.md index 80c3e125660..57c7a9c5996 100644 --- a/src/tools/rust-analyzer/docs/book/src/contributing/README.md +++ b/src/tools/rust-analyzer/docs/book/src/contributing/README.md @@ -282,26 +282,27 @@ There are two sets of people with extra permissions: ## Synchronizing subtree changes `rust-analyzer` is a [josh](https://josh-project.github.io/josh/intro.html) subtree of the [rust-lang/rust](https://github.com/rust-lang/rust) repository. We use the [rustc-josh-sync](https://github.com/rust-lang/josh-sync) tool to perform synchronization between these two -repositories. You can find documentation of the tool [here](https://github.com/rust-lang/josh-sync?tab=readme-ov-file#performing-pull). +repositories. You can find documentation of the tool [here](https://github.com/rust-lang/josh-sync). You can install the synchronization tool using the following commands: ``` cargo install --locked --git https://github.com/rust-lang/josh-sync ``` -Both pulls (synchronize changes from rust-lang/rust into rust-analyzer) and pushes (synchronize +Both pulls (synchronizing changes from rust-lang/rust into rust-analyzer) and pushes (synchronizing +changes from rust-analyzer into rust-lang/rust) are performed from this repository. changes from rust-analyzer to rust-lang/rust) are performed from this repository. Usually we first perform a pull, wait for it to be merged, and then perform a push. ### Performing a pull -1) Checkout a new branch that will be used to create a PR into rust-analyzer +1) Checkout a new branch that will be used to create a PR against rust-analyzer 2) Run the pull command ``` rustc-josh-sync pull ``` 3) Push the branch to your fork of `rust-analyzer` and create a PR - - If you have `gh` CLI installed, `rustc-josh-sync` can create the PR for you. + - If you have the `gh` CLI installed, `rustc-josh-sync` can create the PR for you. ### Performing a push |