diff options
| author | Santiago Pastorino <spastorino@gmail.com> | 2020-03-10 11:01:43 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-10 11:01:43 -0300 |
| commit | 25ccfc7b740536f80d2dd98805a3dd1237a02b2e (patch) | |
| tree | ac543a3249b28452654f86367c024f27413e3a43 /src/doc/rustc-dev-guide/README.md | |
| parent | 5dd0fa1e7b7f707dd730c91b7b0aa99aa19ed4fd (diff) | |
| download | rust-25ccfc7b740536f80d2dd98805a3dd1237a02b2e.tar.gz rust-25ccfc7b740536f80d2dd98805a3dd1237a02b2e.zip | |
Rename rustc-guide to rustc-dev-guide (#601)
* Rename rustc-guide to rustc-dev-guide * rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org
Diffstat (limited to 'src/doc/rustc-dev-guide/README.md')
| -rw-r--r-- | src/doc/rustc-dev-guide/README.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/doc/rustc-dev-guide/README.md b/src/doc/rustc-dev-guide/README.md index a0cd760a2da..09897186237 100644 --- a/src/doc/rustc-dev-guide/README.md +++ b/src/doc/rustc-dev-guide/README.md @@ -1,4 +1,4 @@ - + This is a collaborative effort to build a guide that explains how rustc @@ -6,7 +6,7 @@ works. The aim of the guide is to help new contributors get oriented to rustc, as well as to help more experienced folks in figuring out some new part of the compiler that they haven't worked on before. -[You can read the latest version of the guide here.](https://rust-lang.github.io/rustc-guide/) +[You can read the latest version of the guide here.](https://rustc-dev-guide.rust-lang.org/) You may also find the rustdocs [for the compiler itself][rustdocs] useful. @@ -18,7 +18,7 @@ The guide is useful today, but it has a lot of work still go. If you'd like to help improve the guide, we'd love to have you! You can find plenty of issues on the [issue -tracker](https://github.com/rust-lang/rustc-guide/issues). Just post a +tracker](https://github.com/rust-lang/rustc-dev-guide/issues). Just post a comment on the issue you would like to work on to make sure that we don't accidentally duplicate work. If you think something is missing, please open an issue about it! @@ -55,28 +55,28 @@ You will need `mdbook` version `>= 0.3.5` and `mdbook-linkcheck` version `>= 0.5 4. Follow the check-azure link to get to the Azure website for that build: https://dev.azure.com/rust-lang/e71b0ddf-dd27-435a-873c-e30f86eea377/_build/results?buildId=7780 -5. There will be approximately 1 billion different jobs for the build. They are for different configurations and platforms. The rustc-guide build only runs on the Linux x86_64-gnu-tools job. So click on that job in the list, which is about 60% down in the list. +5. There will be approximately 1 billion different jobs for the build. They are for different configurations and platforms. The rustc-dev-guide build only runs on the Linux x86_64-gnu-tools job. So click on that job in the list, which is about 60% down in the list. 6. Click the Run build step in the job to get the console log for the step. 7. Click on the log and Ctrl-f to get a search box in the log -8. Search for rustc-guide. This gets you to the place where the links are checked. It is usually ~11K lines into the log +8. Search for rustc-dev-guide. This gets you to the place where the links are checked. It is usually ~11K lines into the log 9. Look at the links in the log near that point in the log -10. Fix those links in the rustc-guide (by making a PR in the rustc-guide repo) +10. Fix those links in the rustc-dev-guide (by making a PR in the rustc-dev-guide repo) -11. Make a PR on the rust-lang/rust repo to update the rustc-guide git submodule in src/docs/rustc-guide. +11. Make a PR on the rust-lang/rust repo to update the rustc-dev-guide git submodule in src/docs/rustc-dev-guide. To make a PR, the following steps are useful. ```bash # Assuming you already cloned the rust-lang/rust repo and you're in the correct directory -git submodule update --remote src/doc/rustc-guide +git submodule update --remote src/doc/rustc-dev-guide git add -u -git commit -m "Update rustc-guide" +git commit -m "Update rustc-dev-guide" # Note that you can use -i, which is short for --incremental, in the following command -./x.py test --incremental --stage 1 src/doc/rustc-guide # This is optional and should succeed anyway +./x.py test --incremental --stage 1 src/doc/rustc-dev-guide # This is optional and should succeed anyway # Open a PR in rust-lang/rust ``` |
