Skip to content

Commit 1fdfd58

Browse files
authored
Merge pull request #2344 from rust-lang/tshepang-patch-1
readme: be copy-paste friendly
2 parents 8e69daa + 1bc859e commit 1fdfd58

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ rustdocs][rustdocs].
4343
To build a local static HTML site, install [`mdbook`](https://github.com/rust-lang/mdBook) with:
4444

4545
```
46-
> cargo install mdbook mdbook-linkcheck2 mdbook-toc mdbook-mermaid
46+
cargo install mdbook mdbook-linkcheck2 mdbook-toc mdbook-mermaid
4747
```
4848

4949
and execute the following command in the root of the repository:
5050

5151
```
52-
> mdbook build --open
52+
mdbook build --open
5353
```
5454

5555
The build files are found in the `book/html` directory.
@@ -61,8 +61,8 @@ checking is **not** run by default locally, though it is in CI. To enable it
6161
locally, set the environment variable `ENABLE_LINKCHECK=1` like in the
6262
following example.
6363

64-
```console
65-
$ ENABLE_LINKCHECK=1 mdbook serve
64+
```
65+
ENABLE_LINKCHECK=1 mdbook serve
6666
```
6767

6868
### Table of Contents
@@ -86,14 +86,14 @@ Older versions of `josh-proxy` may not round trip commits losslessly so it is im
8686
1) Checkout a new branch that will be used to create a PR into `rust-lang/rustc-dev-guide`
8787
2) Run the pull command
8888
```
89-
$ cargo run --manifest-path josh-sync/Cargo.toml rustc-pull
89+
cargo run --manifest-path josh-sync/Cargo.toml rustc-pull
9090
```
9191
3) Push the branch to your fork and create a PR into `rustc-dev-guide`
9292
9393
### Push changes from this repository into `rust-lang/rust`
9494
1) Run the push command to create a branch named `<branch-name>` in a `rustc` fork under the `<gh-username>` account
9595
```
96-
$ cargo run --manifest-path josh-sync/Cargo.toml rustc-push <branch-name> <gh-username>
96+
cargo run --manifest-path josh-sync/Cargo.toml rustc-push <branch-name> <gh-username>
9797
```
9898
2) Create a PR from `<branch-name>` into `rust-lang/rust`
9999
@@ -106,5 +106,5 @@ You may observe "Nothing to pull" even if you *know* rustc-pull has something to
106106
To minimize the likelihood of this happening, you may wish to keep a separate *minimal* git config that *only* has `[user]` entries from global git config, then repoint system git to use the minimal git config instead. E.g.
107107
108108
```
109-
$ GIT_CONFIG_GLOBAL=/path/to/minimal/gitconfig GIT_CONFIG_SYSTEM='' cargo +stable run --manifest-path josh-sync/Cargo.toml -- rustc-pull
109+
GIT_CONFIG_GLOBAL=/path/to/minimal/gitconfig GIT_CONFIG_SYSTEM='' cargo +stable run --manifest-path josh-sync/Cargo.toml -- rustc-pull
110110
```

0 commit comments

Comments
 (0)