Skip to content

Commit a5b3474

Browse files
ehussrami3l
authored andcommitted
Update mdbook and fix some source issues.
1 parent 2c34f99 commit a5b3474

File tree

7 files changed

+25
-23
lines changed

7 files changed

+25
-23
lines changed

.github/workflows/ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1190,7 +1190,7 @@ jobs:
11901190
- name: Install mdbook
11911191
run: |
11921192
mkdir mdbook
1193-
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.6/mdbook-v0.4.6-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
1193+
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.37/mdbook-v0.4.37-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
11941194
echo "`pwd`/mdbook" >> $GITHUB_PATH
11951195
- name: Build user-guide
11961196
run: |

.github/workflows/deploy-docs.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
- name: Install mdbook
2424
run: |
2525
mkdir mdbook
26-
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.6/mdbook-v0.4.6-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
26+
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.37/mdbook-v0.4.37-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
2727
echo "`pwd`/mdbook" >> $GITHUB_PATH
2828
- name: Build book
2929
run: |

ci/actions-templates/test-docs-template.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs: # skip-all
1515
- name: Install mdbook
1616
run: |
1717
mkdir mdbook
18-
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.6/mdbook-v0.4.6-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
18+
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.37/mdbook-v0.4.37-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
1919
echo "`pwd`/mdbook" >> $GITHUB_PATH
2020
- name: Build user-guide
2121
run: |

doc/dev-guide/book.toml

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ src = "src"
66
title = "The Rustup developer guide"
77

88
[output.html]
9+
curly-quotes = true
910
edit-url-template = "https://github.com/rust-lang/rustup/edit/master/doc/dev-guide/{path}"
1011
git-repository-url = "https://github.com/rust-lang/rustup/tree/master/doc/dev-guide"
1112
site-url = "https://rust-lang.github.io/rustup/dev-guide"

doc/user-guide/book.toml

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ authors = ["The Rust Project Developers"]
33
title = "The rustup book"
44

55
[output.html]
6+
curly-quotes = true
67
edit-url-template = "https://github.com/rust-lang/rustup/edit/master/doc/user-guide/{path}"
78
git-repository-url = "https://github.com/rust-lang/rustup/tree/master/doc/user-guide"
89
site-url = "https://rust-lang.github.io/rustup/"

doc/user-guide/src/concepts/components.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -30,41 +30,41 @@ Most components have a target-triple suffix, such as
3030
The set of available components may vary with different releases and
3131
toolchains. The following is an overview of the different components:
3232

33-
* `rustc` — The Rust compiler and [Rustdoc].
34-
* `cargo` — [Cargo] is a package manager and build tool.
35-
* `rustfmt` — [Rustfmt] is a tool for automatically formatting code.
36-
* `rust-std` This is the Rust [standard library]. There is a separate
33+
* `rustc` --- The Rust compiler and [Rustdoc].
34+
* `cargo` --- [Cargo] is a package manager and build tool.
35+
* `rustfmt` --- [Rustfmt] is a tool for automatically formatting code.
36+
* `rust-std` --- This is the Rust [standard library]. There is a separate
3737
`rust-std` component for each target that `rustc` supports, such as
3838
`rust-std-x86_64-pc-windows-msvc`. See the [Cross-compilation] chapter for
3939
more detail.
40-
* `rust-docs` This is a local copy of the [Rust documentation]. Use the
40+
* `rust-docs` --- This is a local copy of the [Rust documentation]. Use the
4141
`rustup doc` command to open the documentation in a web browser. Run `rustup
4242
doc --help` for more options.
43-
* `rust-analyzer` [rust-analyzer] is a language server that provides support
43+
* `rust-analyzer` --- [rust-analyzer] is a language server that provides support
4444
for editors and IDEs.
45-
* `clippy` — [Clippy] is a lint tool that provides extra checks for common
45+
* `clippy` --- [Clippy] is a lint tool that provides extra checks for common
4646
mistakes and stylistic choices.
47-
* `miri` — [Miri] is an experimental Rust interpreter, which can be used for
47+
* `miri` --- [Miri] is an experimental Rust interpreter, which can be used for
4848
checking for undefined-behavior.
49-
* `rust-src` This is a local copy of the source code of the Rust standard
49+
* `rust-src` --- This is a local copy of the source code of the Rust standard
5050
library. This can be used by some tools, such as [rust-analyzer], to provide
5151
auto-completion for functions within the standard library; [Miri] which is a
5252
Rust interpreter; and Cargo's experimental [build-std] feature, which allows
5353
you to rebuild the standard library locally.
54-
* `rust-mingw` — This contains a linker and platform libraries for building on
54+
* `rust-mingw` --- This contains a linker and platform libraries for building on
5555
the `x86_64-pc-windows-gnu` platform.
56-
* `llvm-tools` — This component contains a collection of [LLVM] tools.
57-
* `rustc-dev` — This component contains the compiler as a library. Most users
56+
* `llvm-tools` --- This component contains a collection of [LLVM] tools.
57+
* `rustc-dev` --- This component contains the compiler as a library. Most users
5858
will not need this; it is only needed for development *of* tools that link
5959
to the compiler, such as making modifications to [Clippy].
6060

6161
### Previous components
6262

6363
These components have been deprecated and are not published in new Rust releases.
6464

65-
* `rls` [RLS] is a language server that is deprecated and has been replaced
65+
* `rls` --- [RLS] is a language server that is deprecated and has been replaced
6666
by rust-analyzer.
67-
* `rust-analysis` — Metadata about the standard library, used by [RLS].
67+
* `rust-analysis` --- Metadata about the standard library, used by [RLS].
6868

6969
## Component availability
7070

doc/user-guide/src/concepts/index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -25,30 +25,30 @@ This is similar to Ruby's [rbenv], Python's [pyenv], or Node's [nvm].
2525

2626
## Terminology
2727

28-
* **channel** — Rust is released to three different "channels": stable, beta,
28+
* **channel** --- Rust is released to three different "channels": stable, beta,
2929
and nightly. See the [Channels] chapter for more details.
3030

31-
* **toolchain** — A "toolchain" is a complete installation of the Rust
31+
* **toolchain** --- A "toolchain" is a complete installation of the Rust
3232
compiler (`rustc`) and related tools (like `cargo`). A [toolchain
3333
specification] includes the release channel or version, and the host
3434
platform that the toolchain runs on.
3535

36-
* **target** — `rustc` is capable of generating code for many platforms. The
36+
* **target** --- `rustc` is capable of generating code for many platforms. The
3737
"target" specifies the platform that the code will be generated for. By
3838
default, `cargo` and `rustc` use the host toolchain's platform as the
3939
target. To build for a different target, usually the target's standard
4040
library needs to be installed first via the `rustup target` command. See the
4141
[Cross-compilation] chapter for more details.
4242

43-
* **component** — Each release of Rust includes several "components", some of
43+
* **component** --- Each release of Rust includes several "components", some of
4444
which are required (like `rustc`) and some that are optional (like
4545
[`clippy`]). See the [Components] chapter for more detail.
4646

47-
* **profile** — In order to make it easier to work with components, a
47+
* **profile** --- In order to make it easier to work with components, a
4848
"profile" defines a grouping of components. See the [Profiles] chapter for
4949
more details.
5050

51-
* **proxy** —  A wrapper for a common Rust component (like `rustc`), built to forward
51+
* **proxy** --- A wrapper for a common Rust component (like `rustc`), built to forward
5252
CLI invocations to the active Rust toolchain. See the [Proxies] chapter for more details.
5353

5454
[`clippy`]: https://github.com/rust-lang/rust-clippy

0 commit comments

Comments
 (0)