Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 6 commits into from
Mar 11, 2020
Merged

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

merged 6 commits into from
Mar 11, 2020

Conversation

chrissimpkins
Copy link
Member

@chrissimpkins chrissimpkins commented Mar 1, 2020 •
edited
Loading

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
Copy link
Collaborator

r? @nikomatsakis

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 1, 2020
@chrissimpkins
Copy link
Member Author

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
Copy link
Contributor

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

@petrochenkov
Copy link
Contributor

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
Copy link
Contributor

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

@petrochenkov petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 9, 2020
@chrissimpkins
Copy link
Member Author

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
Copy link
Member Author

chrissimpkins commented Mar 10, 2020 •
edited
Loading

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

Added in 0982c58 259b06e

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:

2020-03-09_22-05-50

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 chrissimpkins mentioned this pull request Mar 10, 2020
Merged
@chrissimpkins
Copy link
Member Author

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

@petrochenkov
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Mar 10, 2020

📌 Commit c60d581 has been approved by petrochenkov

@bors
Copy link
Contributor

bors commented Mar 10, 2020

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

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 10, 2020
@Centril Centril mentioned this pull request Mar 11, 2020
Merged
bors added a commit that referenced this pull request Mar 11, 2020
@bors
Auto merge of #69919 - Centril:rollup-fxo33zs, r=Centril
c20d7ee 
Rollup of 8 pull requests

Successful merges:

 - #66472 (--show-coverage json)
 - #69603 (tidy: replace `make check` with `./x.py test` in documentation)
 - #69760 (Improve expression & attribute parsing)
 - #69828 (fix memory leak when vec::IntoIter panics during drop)
 - #69850 (panic_bounds_check: use caller_location, like PanicFnLangItem)
 - #69876 (Add long error explanation for E0739)
 - #69888 ([Miri] Use a session variable instead of checking for an env var always)
 - #69893 (librustc_codegen_llvm: Use slices instead of 0-terminated strings)

Failed merges:

r? @ghost
@bors bors merged commit dde2484 into rust-lang:master Mar 11, 2020
@chrissimpkins chrissimpkins deleted the tidy-docs-update branch March 11, 2020 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petrochenkov petrochenkov petrochenkov left review comments

Assignees

@petrochenkov petrochenkov

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@chrissimpkins @rust-highfive @nikomatsakis @petrochenkov @bors