@@ -49,10 +49,10 @@ To build a local static HTML site, install [`mdbook`](https://github.com/rust-la
4949and execute the following command in the root of the repository:
5050
5151```
52- > mdbook build
52+ > mdbook build --open
5353```
5454
55- The build files are found in the ` book ` directory.
55+ The build files are found in the ` book/html ` directory.
5656
5757### Link Validations
5858
@@ -64,25 +64,6 @@ We use `mdbook-linkcheck` to validate URLs included in our documentation.
6464We use ` mdbook-toc ` to auto-generate TOCs for long sections. You can invoke the preprocessor by
6565including the ` <!-- toc --> ` marker at the place where you want the TOC.
6666
67- ### Pre-commit script
68-
69- We also test that line lengths are less than 100 columns. To test this locally,
70- you can run ` ci/check_line_lengths.sh ` .
71-
72- You can also set this to run automatically.
73-
74- On Linux:
75-
76- ``` bash
77- ln -s ../../ci/check_line_lengths.sh .git/hooks/pre-commit
78- ```
79-
80- On Windows:
81-
82- ``` powershell
83- New-Item -Path .git/hooks/pre-commit -ItemType HardLink -Value <absolute_path/to/check_line_lengths.sh>
84- ```
85-
8667## How to fix toolstate failures
8768
8869> ** NOTE** : Currently, we do not track the rustc-dev-guide toolstate due to
@@ -118,7 +99,7 @@ git submodule update --remote src/doc/rustc-dev-guide
11899git add -u
119100git commit -m " Update rustc-dev-guide"
120101# Note that you can use -i, which is short for --incremental, in the following command
121- ./x.py test --incremental src/doc/rustc-dev-guide # This is optional and should succeed anyway
102+ ./x test --incremental src/doc/rustc-dev-guide # This is optional and should succeed anyway
122103# Open a PR in rust-lang/rust
123104```
124105
0 commit comments