tidy: replace make check with ./x.py test in documentation

[chrissimpkins]

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.

[rust-highfive]

r? @nikomatsakis

(rust_highfive has picked a reviewer for you, use r? to override)

[chrissimpkins]

re: #69603 (comment)

@petrochenkov Here is what I see with ./x.py tidy -h. I think that we should fix this if we are going to consider that sub-command the default approach.

info: Downloading and building bootstrap before processing --help
command. See src/bootstrap/README.md for help with common
commands.
Updating only changed submodules
Submodules updated in 0.05 seconds
Finished dev [unoptimized] target(s) in 0.15s
Usage: x.py <subcommand> [options] [<paths>...]
Subcommands:
build Compile either the compiler or libraries
check Compile either the compiler or libraries, using cargo check
clippy Run clippy (uses rustup/cargo-installed clippy binary)
fix Run cargo fix
fmt Run rustfmt
test Build and run some test suites
bench Build and run some benchmarks
doc Build documentation
clean Clean out build directories
dist Build distribution artifacts
install Install distribution artifacts
To learn more about a subcommand, run `./x.py <subcommand> -h`
failed to run: /Users/chris/code-ext/rustlang/rust/build/bootstrap/debug/bootstrap tidy -h

[nikomatsakis]

r? @petrochenkov -- I didn't know about the shortcut either, so clearly I'm not the best to review. :)

[petrochenkov]

Here is what I see with ./x.py tidy -h.

This is not surprising, given that tidy is not a subcommand by itself, but a target of the x.py test command.

[petrochenkov]

x.py test --help could say something about x.py test src/tools/tool and the x.py test tool shortcut.

[chrissimpkins]

Thanks Vadim!

This is not surprising, given that tidy is not a subcommand by itself, but a target of the x.py test command.

Apologies. I think that I misread the earlier comment.

x.py test --help could say something about x.py test src/tools/tool and the x.py test tool shortcut.

I will update the test help and let you know when it is available.

[chrissimpkins]

There's also a shortcut ./x.py test tidy.

Added in 0982c58259b06e

x.py test --help could say something about x.py test src/tools/tool and the x.py test tool shortcut.

Added in 9f734c9

./x.py test --help includes the following information after these changes:

I believe that I addressed all of your suggestions. Please let me know if there are any other locations in this repository where this information might be of use.

[chrissimpkins]

rust-lang/rustc-dev-guide#607 adds the same recommendation to the rustc-dev-guide

[petrochenkov]

@bors r+ rollup

[bors]

📌 Commit c60d581 has been approved by petrochenkov

[bors]

🌲 The tree is currently closed for pull requests below priority 1000, this pull request will be tested once the tree is reopened