Skip to content

Tiny doc nit about the push destination #5

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 4, 2025
Merged

Tiny doc nit about the push destination #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Josh sync utilities
This repository contains a binary utility for performing [Josh](https://github.com/josh-project/josh)
synchronizations (pull and push) of Josh subtrees in the [rust-lang/rust](https://github.com/rust-lang/rust) repository.
synchronizations (pull and push) of Josh subtrees in the [rust-lang/rust] repository.

## Installation
You can install the binary `rustc-josh-sync` tool using the following command:
Expand Down Expand Up @@ -34,11 +34,11 @@ A push operation takes changes performed in the subtree repository and merges th
1) Checkout the latest default branch of the subtree
2) Run `rustc-josh-sync pull <your-github-username> <branch>`
- The branch with the push contents will be created in `https://github.com/<your-github-username>/rust` fork, in the `<branch>` branch.
3) Send a PR to `rustc`
3) Send a PR to [rust-lang/rust]

## Git pecularities
## Git peculiarities

NOTE: If you use Git/SSH protocol to push to your fork of `rust-lang/rust`,
NOTE: If you use Git/SSH protocol to push to your fork of [rust-lang/rust],
ensure that you have this entry in your Git config,
else the 2 steps that follow would prompt for a username and password:

Expand All @@ -58,3 +58,6 @@ To minimize the likelihood of this happening, you may wish to keep a separate *m
```
GIT_CONFIG_GLOBAL=/path/to/minimal/gitconfig GIT_CONFIG_SYSTEM='' rustc-josh-sync ...
```


[rust-lang/rust]: (https://github.com/rust-lang/rust)
Loading