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

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

Merged
merged 4 commits into from
Jun 25, 2023
Merged

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

merged 4 commits into from
Jun 25, 2023

Commits on Jun 24, 2023

  1. outline x.py alternate invocations to the dev guide 

    almost no one on windows builds from source unless they're contributing,
and `./x.py` just works on most unix systems.
    @jyn514
    jyn514 committed Jun 24, 2023
    Configuration menu
    Copy the full SHA
    b556e28 View commit details
    Browse the repository at this point in the history

  2. give more helpful suggestions for a missing feature gate test

    @jyn514
    jyn514 committed Jun 24, 2023
    Configuration menu
    Copy the full SHA
    dd314f6 View commit details
    Browse the repository at this point in the history

  3. Give a better error on Windows if python isn't installed 

    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
```
    @jyn514
    jyn514 committed Jun 24, 2023
    Configuration menu
    Copy the full SHA
    fa7e965 View commit details
    Browse the repository at this point in the history

  4. Don't print "x.ps1" 

    This is left over from adding `Get-Command -syntax`; it's not helpful.
    @jyn514
    jyn514 committed Jun 24, 2023
    Configuration menu
    Copy the full SHA
    664ffa4 View commit details
    Browse the repository at this point in the history