Skip to content

Commit 4af200d

Browse files
authored
Merge pull request #5 from jieyouxu/fix-readme
Tiny doc nit about the push destination
2 parents 8245142 + 560c437 commit 4af200d

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Josh sync utilities
22
This repository contains a binary utility for performing [Josh](https://github.com/josh-project/josh)
3-
synchronizations (pull and push) of Josh subtrees in the [rust-lang/rust](https://github.com/rust-lang/rust) repository.
3+
synchronizations (pull and push) of Josh subtrees in the [rust-lang/rust] repository.
44

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

39-
## Git pecularities
39+
## Git peculiarities
4040

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

@@ -58,3 +58,6 @@ To minimize the likelihood of this happening, you may wish to keep a separate *m
5858
```
5959
GIT_CONFIG_GLOBAL=/path/to/minimal/gitconfig GIT_CONFIG_SYSTEM='' rustc-josh-sync ...
6060
```
61+
62+
63+
[rust-lang/rust]: (https://github.com/rust-lang/rust)

0 commit comments

Comments
 (0)