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.

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

Move some docs from the README to the dev-guide #113008

Merged
merged 4 commits into from
Jun 25, 2023

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Jun 24, 2023

and as a drive-by cleanup, improve the error message for x test tidy when a feature gate is missing.

This also improves the error message you get on Windows if python isn't installed.

cc rust-lang/libs-team#242 (comment), rust-lang/rustc-dev-guide#1701

almost no one on windows builds from source unless they're contributing,
and `./x.py` just works on most unix systems.
@jyn514
Copy link
Member Author

jyn514 commented Jun 24, 2023

@bors rollup

@rustbot
Copy link
Collaborator

rustbot commented Jun 24, 2023

r? @clubby789

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

@rustbot rustbot added A-meta Area: Issues & PRs about the rust-lang/rust repository itself A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Jun 24, 2023
@jyn514 jyn514 force-pushed the new-contributor-improvements branch from 363918e to e9d83bf Compare June 24, 2023 18:45
x.ps1 Outdated Show resolved Hide resolved
@jyn514 jyn514 force-pushed the new-contributor-improvements branch from e9d83bf to 96f7bfc Compare June 24, 2023 18:51
x.ps1 Outdated Show resolved Hide resolved
Before:

```
PS C:\Users\vboxuser\rust> ./x
x.ps1

PS C:\Users\vboxuser\rust>
```

After:
```
PS C:\Users\vboxuser\rust> ./x
x.ps1

C:\Users\vboxuser\rust\x.ps1 : C:\Users\vboxuser\rust\x.ps1: error: did not find python installed
help: consider installing it from https://www.python.org/downloads/windows/
At line:1 char:1
+ ./x
+ ~~~
    + CategoryInfo          : NotInstalled: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,x.ps1
```

The existing message from the shell script is already decent and I decided not to change it:
```
$ ./x
Python was not found but can be installed from the Microsoft Store: ms-windows-store://pdp/?productid=9NJ46SX7X90P
```
This is left over from adding `Get-Command -syntax`; it's not helpful.
@jyn514 jyn514 force-pushed the new-contributor-improvements branch from 96f7bfc to 664ffa4 Compare June 24, 2023 19:45
@clubby789
Copy link
Contributor

@bors r+

@bors
Copy link
Contributor

bors commented Jun 24, 2023

📌 Commit 664ffa4 has been approved by clubby789

It is now in the queue for this repository.

@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-review Status: Awaiting review from the assignee but also interested parties. labels Jun 24, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 25, 2023
…iaskrgr

Rollup of 5 pull requests

Successful merges:

 - rust-lang#112937 (rustdoc: Align search results horizontally for easy scanning)
 - rust-lang#112950 (DirEntry::file_name: improve explanation)
 - rust-lang#112956 (Expose `compiler-builtins-weak-intrinsics` feature for `-Zbuild-std`)
 - rust-lang#113008 (Move some docs from the README to the dev-guide)
 - rust-lang#113009 (Remove unnecessary `path` attribute)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 85a7bb4 into rust-lang:master Jun 25, 2023
@rustbot rustbot added this to the 1.72.0 milestone Jun 25, 2023
@jyn514 jyn514 deleted the new-contributor-improvements branch June 25, 2023 04:49
@albertlarsan68
Copy link
Member

I haven't yet verified this, but I think it breaks people like me who use the Store's python.

@jyn514
Copy link
Member Author

jyn514 commented Jun 25, 2023

I don't want to make a Microsoft account to test this. If you could post the error you see, that would be very helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-meta Area: Issues & PRs about the rust-lang/rust repository itself A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants