Skip to content

Commit

Permalink
Fix xtask args which are unmodified when upgrading xtask commands (#2364
Browse files Browse the repository at this point in the history
)
  • Loading branch information
tiruka authored Oct 21, 2024
1 parent 80c831b commit 3b51c26
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ There are a few commands you will want to run prior to any commit for a non-draf
2. `cargo clippy --fix` will run [Clippy](https://github.com/rust-lang/rust-clippy) and fix any
coding issues it can. Clippy necessitates to be in a clean Git state, but this can be
circumvented by adding the `--allow-dirty` flag.
3. `cargo xtask run-checks all` is a script located in the project root that builds and tests the
3. `cargo xtask check all` is a script located in the project root that builds and tests the
project. It is required to run successfully prior to merging a PR. Fair warning, running these
tests can take a while[^linux_mem_note].

Expand All @@ -34,7 +34,7 @@ Alternatively, if you want to install mdbook directly, run the following command
cargo install mdbook
```

Also instead of running `cargo xtask run-checks all`, you can run `cargo xtask run-checks typos` to
Also instead of running `cargo xtask check all`, you can run `cargo xtask check typos` to
only check for misspellings. This will install [typo](https://crates.io/crates/typos-cli), and if
any are encountered you should be able to run `typo -w /path/to/book` to fix them.

Expand Down

0 comments on commit 3b51c26

Please sign in to comment.