Provide better documentation and help messages for x.py setup #77879

ijackson · 2020-10-12T23:57:55Z

I have split this up into tiny comments because I find it clearer this way. Feel free to squash it.

rust-highfive · 2020-10-12T23:57:58Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

Mark-Simulacrum · 2020-10-13T00:34:55Z

r? @jyn514

jyn514

Thanks for working on this! Lots of little nits, but the approach looks good.

src/bootstrap/flags.rs

src/bootstrap/setup.rs

ijackson · 2020-10-13T11:49:37Z

Thanks for the review. I think I've addressed everything. I have only marked as "resolved" those comments where I did precisely what you suggested, so for the others you can decide for yourself if you agree with me.

jyn514

Two other small nits, I agreed with the rest of your changes :)

src/bootstrap/flags.rs

src/bootstrap/setup.rs

jyn514 · 2020-10-13T14:30:12Z

Can you squash the commits a little? r=me after that.

jyn514 · 2020-10-13T14:30:20Z

Thanks for working on this!

src/bootstrap/setup.rs

ijackson · 2020-10-13T17:27:56Z

I found another preexisting bug which I also fixed - see the final commit in the squashed series.

src/bootstrap/setup.rs

jyn514 · 2020-10-13T17:53:54Z

@bors r+

bors · 2020-10-13T17:53:55Z

📌 Commit 9dd00168a593bbb8c55e621a937552fd51eb5824 has been approved by jyn514

bors · 2020-10-14T00:58:35Z

☔ The latest upstream changes (presumably #77917) made this pull request unmergeable. Please resolve the merge conflicts.

Note that reviewers usually do not review pull requests until merge conflicts are resolved! Once you resolve the conflicts, you should change the labels applied by bors to indicate that your PR is ready for review. Post this as a comment to change the labels:

@rustbot modify labels: +S-waiting-on-review -S-waiting-on-author

Rollup of 8 pull requests Successful merges: - rust-lang#77765 (Add LLVM flags to limit DWARF version to 2 on BSD) - rust-lang#77788 (BTreeMap: fix gdb provider on BTreeMap with ZST keys or values) - rust-lang#77795 (Codegen backend interface refactor) - rust-lang#77808 (Moved the main `impl` for FnCtxt to its own file.) - rust-lang#77817 (Switch rustdoc from `clean::Stability` to `rustc_attr::Stability`) - rust-lang#77829 (bootstrap: only use compiler-builtins-c if they exist) - rust-lang#77870 (Use intra-doc links for links to module-level docs) - rust-lang#77897 (Move `Strip` into a separate rustdoc pass) Failed merges: - rust-lang#77879 (Provide better documentation and help messages for x.py setup) - rust-lang#77902 (Include aarch64-pc-windows-msvc in the dist manifests) r? `@ghost`

bors · 2020-10-14T05:26:43Z

🔒 Merge conflict

This pull request and the master branch diverged in a way that cannot be automatically merged. Please rebase on top of the latest master branch, and let the reviewer approve again.

How do I rebase?

Assuming self is your fork and upstream is this repository, you can resolve the conflict following these steps:

git checkout x-py (switch to your branch)
git fetch upstream master (retrieve the latest master)
git rebase upstream/master -p (rebase on top of it)
Follow the on-screen instruction to resolve conflicts (check git status if you got lost).
git push self x-py --force-with-lease (update this PR)

You may also read Git Rebasing to Resolve Conflicts by Drew Blessing for a short tutorial.

Please avoid the "Resolve conflicts" button on GitHub. It uses git merge instead of git rebase which makes the PR commit history more difficult to read.

Sometimes step 4 will complete without asking for resolution. This is usually due to difference between how Cargo.lock conflict is handled during merge and rebase. This is normal, and you should still perform step 5 to update this PR.

Error message

Auto-merging src/bootstrap/setup.rs
CONFLICT (content): Merge conflict in src/bootstrap/setup.rs
Auto-merging src/bootstrap/flags.rs
Automatic merge failed; fix conflicts and then commit the result.

Put all()'s otuput in the order we want to print things in, and add a comment about why they are in this order. Provide purpose() and all_for_help(). Use these things everywhere. Move all the abbrev character ("a", "b", etc.) processing into interactive_path. No functional change. Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

We understand these profile names because we use .to_str(). Mention them in the question. Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

We need a fresh input buffer each time, or we reuse the previous data (since `read_line` appends). Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

EOF is not an error; it just causes read_line to produce "". Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

ijackson · 2020-10-14T11:09:31Z

@jyn514 Would you mind re-reviewing? Thanks. (The merge conflicts were with 23c3356 "Mention rustdoc in x.py setup".)

jyn514 · 2020-10-14T12:56:20Z

@bors r+

bors · 2020-10-14T12:56:22Z

📌 Commit 636728e has been approved by jyn514

bors · 2020-10-14T15:24:15Z

⌛ Testing commit 636728e with merge 8d0cfd54d89abbac3a21d5121fda76fed10569df...

bors · 2020-10-14T16:56:37Z

💔 Test failed - checks-actions

jyn514 · 2020-10-14T17:02:39Z

Spurious failure; it's the second time it's happened so I don't think there's much point in retrying. Opened https://rust-lang.zulipchat.com/#narrow/stream/242791-t-infra/topic/All.20apple.20builds.20are.20failing instead.

jyn514 · 2020-10-14T17:21:59Z

@bors retry

#77940

Rollup of 9 pull requests Successful merges: - rust-lang#77570 (Allow ascii whitespace char for doc aliases ) - rust-lang#77739 (Remove unused code) - rust-lang#77753 (Check html comments) - rust-lang#77879 (Provide better documentation and help messages for x.py setup) - rust-lang#77902 (Include aarch64-pc-windows-msvc in the dist manifests) - rust-lang#77934 (Document -Z codegen-backend in the unstable book) - rust-lang#77936 (Remove needless alloc_slice) - rust-lang#77946 (Validate references to source scopes) - rust-lang#77951 (Update books) Failed merges: r? `@ghost`

rust-highfive assigned Mark-Simulacrum Oct 12, 2020

ijackson force-pushed the x-py branch from 5672e79 to 4d5ec5e Compare October 12, 2020 23:57

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 12, 2020

ijackson force-pushed the x-py branch from 4d5ec5e to 86c7e83 Compare October 13, 2020 00:00

rust-highfive assigned jyn514 and unassigned Mark-Simulacrum Oct 13, 2020

jyn514 added A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Oct 13, 2020

jyn514 reviewed Oct 13, 2020

View reviewed changes

jyn514 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 Oct 13, 2020

jyn514 reviewed Oct 13, 2020

View reviewed changes

src/bootstrap/flags.rs Outdated Show resolved Hide resolved

src/bootstrap/setup.rs Outdated Show resolved Hide resolved

pickfire reviewed Oct 13, 2020

View reviewed changes

src/bootstrap/setup.rs Show resolved Hide resolved

ijackson force-pushed the x-py branch from 2528ca1 to 2536e1a Compare October 13, 2020 17:26

jyn514 reviewed Oct 13, 2020

View reviewed changes

src/bootstrap/setup.rs Outdated Show resolved Hide resolved

ijackson force-pushed the x-py branch from 2536e1a to 9dd0016 Compare October 13, 2020 17:46

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 Oct 13, 2020

Dylan-DPC-zz mentioned this pull request Oct 14, 2020

Rollup of 8 pull requests #77926

Merged

bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 14, 2020

ijackson and others added 5 commits October 14, 2020 11:40

x.py: setup: Provide a description of what it does

b7c6041

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

x.py: setup: Offer keywords in interactive prompt

6e9e040

We understand these profile names because we use .to_str(). Mention them in the question. Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

x.py setup: Fix handling of wrong interactive input

e905857

We need a fresh input buffer each time, or we reuse the previous data (since `read_line` appends). Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

x.py setup: Avoid infinite loop if stdin is /dev/null

636728e

EOF is not an error; it just causes read_line to produce "". Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

ijackson force-pushed the x-py branch from 9dd0016 to 636728e Compare October 14, 2020 10:42

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 Oct 14, 2020

bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 14, 2020

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 Oct 14, 2020

JohnTitor mentioned this pull request Oct 14, 2020

Rollup of 9 pull requests #77954

Merged

bors merged commit c268cc0 into rust-lang:master Oct 15, 2020

rustbot added this to the 1.49.0 milestone Oct 15, 2020

ijackson deleted the x-py branch October 28, 2020 15:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provide better documentation and help messages for x.py setup #77879

Provide better documentation and help messages for x.py setup #77879

ijackson commented Oct 12, 2020

rust-highfive commented Oct 12, 2020

Mark-Simulacrum commented Oct 13, 2020

jyn514 left a comment

ijackson commented Oct 13, 2020

jyn514 left a comment

jyn514 commented Oct 13, 2020

jyn514 commented Oct 13, 2020

ijackson commented Oct 13, 2020

jyn514 commented Oct 13, 2020

bors commented Oct 13, 2020

bors commented Oct 14, 2020

bors commented Oct 14, 2020

ijackson commented Oct 14, 2020

jyn514 commented Oct 14, 2020

bors commented Oct 14, 2020

bors commented Oct 14, 2020

bors commented Oct 14, 2020

jyn514 commented Oct 14, 2020

jyn514 commented Oct 14, 2020

Provide better documentation and help messages for x.py setup #77879

Provide better documentation and help messages for x.py setup #77879

Conversation

ijackson commented Oct 12, 2020

rust-highfive commented Oct 12, 2020

Mark-Simulacrum commented Oct 13, 2020

jyn514 left a comment

Choose a reason for hiding this comment

ijackson commented Oct 13, 2020

jyn514 left a comment

Choose a reason for hiding this comment

jyn514 commented Oct 13, 2020

jyn514 commented Oct 13, 2020

ijackson commented Oct 13, 2020

jyn514 commented Oct 13, 2020

bors commented Oct 13, 2020

bors commented Oct 14, 2020

bors commented Oct 14, 2020

ijackson commented Oct 14, 2020

jyn514 commented Oct 14, 2020

bors commented Oct 14, 2020

bors commented Oct 14, 2020

bors commented Oct 14, 2020

jyn514 commented Oct 14, 2020

jyn514 commented Oct 14, 2020