Streamline the user experience for x.py setup
#104952
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Before, the submodule handling was very jank and would update *between two interactive prompts*:
```
; x setup
Building rustbuild
Finished dev [unoptimized] target(s) in 0.05s
Welcome to the Rust project! What do you want to do with x.py?
a) library: Contribute to the standard library
Please choose one (a/b/c/d/e): a
Updating submodule library/backtrace
Submodule 'library/backtrace' (https://github.com/rust-lang/backtrace-rs.git) registered for path 'library/backtrace'
error: you asked `x.py` to setup a new config file, but one already exists at `config.toml`
Build completed unsuccessfully in 0:00:02
```
That's not a great user experience because you need to wait a long time between prompts.
It would be possible to move the submodule handling either before or after the prompt, but it seems
better to just not require submodules to be checked out at all, to minimize the time spend waiting
just to create a new configuration.
- Create `config.toml` last. It's the most likely to error, and used to stop later steps from executing - Don't print an error message + exit if the git hook already exists; that's expected
|
(rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
T-bootstrap
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Dec 5, 2022
Streamline the user experience for `x.py setup`
## Don't update submodules for x setup
Before, the submodule handling was very jank and would update *between two interactive prompts*:
```
; x setup
Building rustbuild
Finished dev [unoptimized] target(s) in 0.05s
Welcome to the Rust project! What do you want to do with x.py?
a) library: Contribute to the standard library
Please choose one (a/b/c/d/e): a
Updating submodule library/backtrace
Submodule 'library/backtrace' (https://github.com/rust-lang/backtrace-rs.git) registered for path 'library/backtrace'
error: you asked `x.py` to setup a new config file, but one already exists at `config.toml`
Build completed unsuccessfully in 0:00:02
```
That's not a great user experience because you need to wait a long time between prompts.
It would be possible to move the submodule handling either before or after the prompt, but it seems
better to just not require submodules to be checked out at all, to minimize the time spend waiting
just to create a new configuration.
## Revamp the order setup executes
- Create `config.toml` last. It's the most likely to error, and used to stop later steps from executing
- Don't print an error message + exit if the git hook already exists; that's expected
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Dec 5, 2022
…Mark-Simulacrum Ensure required submodules at the same time as updating existing submodules In practice, this would always happen at the same time, but putting them next to each other makes that more obvious and ensures it doesn't change in the future. It also avoids the difference affecting `cargo metadata` somehow. This is based on rust-lang#104952 for convenience to avoid merge conflicts, but doesn't depend on that PR.
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Dec 5, 2022
…Mark-Simulacrum Ensure required submodules at the same time as updating existing submodules In practice, this would always happen at the same time, but putting them next to each other makes that more obvious and ensures it doesn't change in the future. It also avoids the difference affecting `cargo metadata` somehow. This is based on rust-lang#104952 for convenience to avoid merge conflicts, but doesn't depend on that PR.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 5, 2022
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#104912 (PartialEq: PERs are homogeneous) - rust-lang#104952 (Streamline the user experience for `x.py setup`) - rust-lang#104953 (Ensure required submodules at the same time as updating existing submodules) - rust-lang#105180 (Use proper HirId for async track_caller attribute check) - rust-lang#105222 (std update libc version and freebsd image build dependencies) - rust-lang#105223 (suggest parenthesis around ExprWithBlock BinOp ExprWithBlock) - rust-lang#105230 (Skip recording resolution for duplicated generic params.) - rust-lang#105301 (update Miri) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
RalfJung
pushed a commit
to RalfJung/miri
that referenced
this pull request
Dec 9, 2022
…lacrum Ensure required submodules at the same time as updating existing submodules In practice, this would always happen at the same time, but putting them next to each other makes that more obvious and ensures it doesn't change in the future. It also avoids the difference affecting `cargo metadata` somehow. This is based on rust-lang/rust#104952 for convenience to avoid merge conflicts, but doesn't depend on that PR.
Aaron1011
pushed a commit
to Aaron1011/rust
that referenced
this pull request
Jan 6, 2023
Streamline the user experience for `x.py setup`
## Don't update submodules for x setup
Before, the submodule handling was very jank and would update *between two interactive prompts*:
```
; x setup
Building rustbuild
Finished dev [unoptimized] target(s) in 0.05s
Welcome to the Rust project! What do you want to do with x.py?
a) library: Contribute to the standard library
Please choose one (a/b/c/d/e): a
Updating submodule library/backtrace
Submodule 'library/backtrace' (https://github.com/rust-lang/backtrace-rs.git) registered for path 'library/backtrace'
error: you asked `x.py` to setup a new config file, but one already exists at `config.toml`
Build completed unsuccessfully in 0:00:02
```
That's not a great user experience because you need to wait a long time between prompts.
It would be possible to move the submodule handling either before or after the prompt, but it seems
better to just not require submodules to be checked out at all, to minimize the time spend waiting
just to create a new configuration.
## Revamp the order setup executes
- Create `config.toml` last. It's the most likely to error, and used to stop later steps from executing
- Don't print an error message + exit if the git hook already exists; that's expected
Aaron1011
pushed a commit
to Aaron1011/rust
that referenced
this pull request
Jan 6, 2023
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#104912 (PartialEq: PERs are homogeneous) - rust-lang#104952 (Streamline the user experience for `x.py setup`) - rust-lang#104953 (Ensure required submodules at the same time as updating existing submodules) - rust-lang#105180 (Use proper HirId for async track_caller attribute check) - rust-lang#105222 (std update libc version and freebsd image build dependencies) - rust-lang#105223 (suggest parenthesis around ExprWithBlock BinOp ExprWithBlock) - rust-lang#105230 (Skip recording resolution for duplicated generic params.) - rust-lang#105301 (update Miri) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Don't update submodules for x setup
Before, the submodule handling was very jank and would update between two interactive prompts:
That's not a great user experience because you need to wait a long time between prompts.
It would be possible to move the submodule handling either before or after the prompt, but it seems
better to just not require submodules to be checked out at all, to minimize the time spend waiting
just to create a new configuration.
Revamp the order setup executes
config.tomllast. It's the most likely to error, and used to stop later steps from executing