Skip to content

Commit dde2484

Browse files
authored
Rollup merge of #69603 - chrissimpkins:tidy-docs-update, r=petrochenkov
tidy: replace `make check` with `./x.py test` in documentation This PR includes a minor documentation update for tidy. It replaces the `make check` approach with `./x.py test` and describes how to execute the tidy checks (only) with ~~`./x.py test src/tools/tidy`~~ `./x.py test tidy`.
2 parents 741d4ff + c60d581 commit dde2484

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ the issue in question.
142142
Please make sure your pull request is in compliance with Rust's style
143143
guidelines by running
144144

145-
$ python x.py test src/tools/tidy
145+
$ python x.py test tidy
146146

147147
Make this check before every pull request (and every new commit in a pull
148148
request); you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)

src/bootstrap/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ The script accepts commands, flags, and arguments to determine what to do:
5555
# run all unit tests
5656
./x.py test
5757
58+
# execute tool tests
59+
./x.py test tidy
60+
5861
# execute the UI test suite
5962
./x.py test src/test/ui
6063

src/bootstrap/flags.rs

+5-1
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ Arguments:
359359
subcommand_help.push_str(
360360
"\n
361361
Arguments:
362-
This subcommand accepts a number of paths to directories to tests that
362+
This subcommand accepts a number of paths to test directories that
363363
should be compiled and run. For example:
364364
365365
./x.py test src/test/ui
@@ -372,6 +372,10 @@ Arguments:
372372
just like `build src/libstd --stage N` it tests the compiler produced by the previous
373373
stage.
374374
375+
Execute tool tests with a tool name argument:
376+
377+
./x.py test tidy
378+
375379
If no arguments are passed then the complete artifacts for that stage are
376380
compiled and tested.
377381

src/tools/tidy/src/main.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
//! Tidy checks source code in this repository.
22
//!
33
//! This program runs all of the various tidy checks for style, cleanliness,
4-
//! etc. This is run by default on `make check` and as part of the auto
5-
//! builders.
4+
//! etc. This is run by default on `./x.py test` and as part of the auto
5+
//! builders. The tidy checks can be executed with `./x.py test tidy`.
66
77
#![deny(warnings)]
88

0 commit comments

Comments
 (0)