Fix #9350 (cargo build -Z help is missing options) #9369

PicoJr · 2021-04-17T15:39:25Z

Do not merge yet, some options are still undocumented.

Fix #9350 (cargo build -Z help is missing options)

Add a procedural macro to declare CliUnstable struct and provide help messages instead of hard-coding help in src/bin/cargo/cli.rs

Flags documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html

Feedback welcome

* Add automatic padding when displaying options. * Update test. * run cargo fmt.

rust-highfive · 2021-04-17T15:39:27Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Eh2406 (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.

tests/testsuite/help.rs

src/cargo/core/features.rs

ehuss · 2021-04-18T17:46:54Z

r? ehuss

Looking good! A few things:

The underscores need to be converted to dashes when displayed in the help.
Some of these options should be hidden. I think it would be fine to have an empty string mean hidden, and to maybe use a const HIDDEN to make that clearer. I think the ones that should be hidden are:
- print_im_a_teapot
- advanced_env
- features
- separate_nightlies
Can you write small help strings for the entries that are empty? There is some documentation at https://doc.rust-lang.org/nightly/cargo/reference/unstable.html that should cover most of them (unfortunately some are missing). I can help with any that aren't clear.

Co-authored-by: Eric Huss <eric@huss.org>

* add HIDDEN constant, do not display hidden options * write small help strings for empty entries when possible (else write TODO) * convert snake_case to kebab-case when displaying options * update test

PicoJr · 2021-04-18T19:45:26Z

Entries not meant to be hidden and without a help message contain "TODO" for now.

https://doc.rust-lang.org/nightly/cargo/reference/unstable.html does not provide a documentation for those entries.

I'm not confident with the help messages for:

binary-dep-depinfo
panic-abort-tests

@ehuss thanks for the review :)

ehuss

Thanks!

I think this uncovered an issue where the CLI option -Z future-incompat-report doesn't match the field name enable_future_incompat_feature. I would probably prefer to just rename the field to match. I think its best if all the options match the actual cli name anyways.

src/cargo/core/features.rs

Co-authored-by: Eric Huss <eric@huss.org>

PicoJr · 2021-04-19T19:19:23Z

Thanks!

I think this uncovered an issue where the CLI option -Z future-incompat-report doesn't match the field name enable_future_incompat_feature. I would probably prefer to just rename the field to match. I think its best if all the options match the actual cli name anyways.

I'll rename this field to match the option name.

Rename the field so that it has the same name as the corresponding unstable feature.

ehuss · 2021-04-19T21:00:59Z

Sorry, one last thing that I noticed. Can the first few lines be moved into the macro definition itself? Similar to the features! macro in the same file, the struct itself can be defined in the macro. That should simplify it some so it doesn't need to match on all those elements (this macro won't be reused, so it's fine to embed the struct name inside it). I would also probably remove the pub prefixes, since every field is pub there isn't a need to repeat that in the macro call, and just force every field to be pub in the definition.

ehuss · 2021-04-20T21:46:54Z

Sweet, thank you very much!

@bors r+ squash

bors · 2021-04-20T21:46:55Z

📌 Commit 4f8f80d has been approved by ehuss

bors · 2021-04-20T21:47:03Z

⌛ Testing commit 4f8f80d with merge c51e3338e0a515425891a211e55e6632bec64b0f...

bors · 2021-04-20T21:54:19Z

💔 Test failed - checks-actions

ehuss · 2021-04-20T21:58:18Z

Oops, sorry, forgot that the docs should be updated. I pushed a small fix for that.

@bors r+ squash

bors · 2021-04-20T21:58:19Z

📌 Commit 1cbfced has been approved by ehuss

bors · 2021-04-20T21:58:25Z

⌛ Testing commit 1cbfced with merge a18936b...

Fix #9350 (cargo build -Z help is missing options) > Do not merge yet, some options are still undocumented. Fix #9350 (cargo build -Z help is missing options) Add a procedural macro to declare `CliUnstable` struct and provide help messages instead of hard-coding help in `src/bin/cargo/cli.rs` > Flags documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html Feedback welcome

bors · 2021-04-20T22:27:02Z

☀️ Test successful - checks-actions
Approved by: ehuss
Pushing a18936b to master...

ehuss · 2021-04-20T22:56:28Z

Closing since bors didn't auto-close (see rust-lang/homu#136).

Update cargo, rls ## cargo 18 commits in 65d57e6f384c2317f76626eac116f683e2b63665..0ed318d182e465cd66071b91ac3d265af63ef8a1 2021-04-04 15:07:52 +0000 to 2021-04-23 20:54:54 +0000 - Restore crates.io's `SourceId` hash value to before (rust-lang/cargo#9397) - Fix loading `branch=master` patches in the v3 lock transition (rust-lang/cargo#9392) - Update changelog for 1.52 beta changes. (rust-lang/cargo#9396) - Fix build-std updating the index on every build. (rust-lang/cargo#9393) - Fix typo in profile docs (rust-lang/cargo#9386) - Fix disagreement about lockfile ordering on stable/nightly (rust-lang/cargo#9384) - Don't give a hard error when the end-user specifies RUSTC_BOOTSTRAP=crate_name (rust-lang/cargo#9365) - Fix rust-lang/cargo#9350 (cargo build -Z help is missing options) (rust-lang/cargo#9369) - an struct -> a struct (rust-lang/cargo#9379) - Handle man pages better on Windows. (rust-lang/cargo#9378) - fix: better error message when dependency/workspace member missing (rust-lang/cargo#9368) - Fix typo in book (rust-lang/cargo#9376) - Don't re-use rustc cache when RUSTC_WRAPPER changes (rust-lang/cargo#9348) - doc: add split-debuginfo doc in config chapter (rust-lang/cargo#9372) - refactor: remove `CargoResultExt` (rust-lang/cargo#9367) - Track "CARGO" in environment fingerprint. (rust-lang/cargo#9363) - Update clippy lint allow set. (rust-lang/cargo#9356) - Fix 'suport' typo in documentation (rust-lang/cargo#9338) ## rls 3 commits in 32c0fe006dcdc13e1ca0ca31de543e4436c1299e..74d1800c25498689c5b5120a1e8495fce0cd0d0d 2021-04-12 11:21:12 +0000 to 2021-04-22 21:29:51 +0000 - Bump default integration test message timeout to 30s (rust-lang/rls#1731) - itertools = 0.9, fst = 0.4 (rust-lang/rls#1729) - Update cargo (rust-lang/rls#1728)

PicoJr added 2 commits April 16, 2021 22:12

Add coarse fix to rust-lang#9350 (WIP)

d5e01bf

Rename and improve cli_options macro

cefbcb8

* Add automatic padding when displaying options. * Update test. * run cargo fmt.

rust-highfive assigned Eh2406 Apr 17, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 17, 2021

ehuss reviewed Apr 18, 2021

View reviewed changes

tests/testsuite/help.rs Outdated Show resolved Hide resolved

src/cargo/core/features.rs Outdated Show resolved Hide resolved

ehuss assigned ehuss and unassigned Eh2406 Apr 18, 2021

PicoJr and others added 2 commits April 18, 2021 20:41

Update tests/testsuite/help.rs

8268bbe

Co-authored-by: Eric Huss <eric@huss.org>

Fix unstable options help

de8074f

* add HIDDEN constant, do not display hidden options * write small help strings for empty entries when possible (else write TODO) * convert snake_case to kebab-case when displaying options * update test

ehuss reviewed Apr 19, 2021

View reviewed changes

PicoJr and others added 8 commits April 19, 2021 21:13

Update src/cargo/core/features.rs

131aec8

Co-authored-by: Eric Huss <eric@huss.org>

Update src/cargo/core/features.rs

7da53dc

Co-authored-by: Eric Huss <eric@huss.org>

Update src/cargo/core/features.rs

e820837

Co-authored-by: Eric Huss <eric@huss.org>

Update src/cargo/core/features.rs

9ea78ba

Co-authored-by: Eric Huss <eric@huss.org>

Update src/cargo/core/features.rs

65173a5

Co-authored-by: Eric Huss <eric@huss.org>

Update src/cargo/core/features.rs

b9272c5

Co-authored-by: Eric Huss <eric@huss.org>

Update src/cargo/core/features.rs

dee8dd9

Co-authored-by: Eric Huss <eric@huss.org>

Update src/cargo/core/features.rs

1eb8588

Co-authored-by: Eric Huss <eric@huss.org>

Rename enable_future_incompat_feature -> future_incompat_report

e742b89

Rename the field so that it has the same name as the corresponding unstable feature.

Simplify macro

4f8f80d

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 Apr 20, 2021

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 Apr 20, 2021

Update docs on updating CliUnstable.

1cbfced

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 Apr 20, 2021

This was referenced Apr 20, 2021

[WIP] Add flag to warn about unused dependencies #8437

Closed

mention RUSTFLAGS in -Z unknown error #9318

Closed

ehuss closed this Apr 20, 2021

PicoJr deleted the fix-9350 branch April 21, 2021 09:43

ehuss mentioned this pull request Apr 21, 2021

Update cargo, rls rust-lang/rust#84412

Merged

ehuss added this to the 1.53.0 milestone Feb 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #9350 (cargo build -Z help is missing options) #9369

Fix #9350 (cargo build -Z help is missing options) #9369

PicoJr commented Apr 17, 2021 •

edited

Loading

rust-highfive commented Apr 17, 2021

ehuss commented Apr 18, 2021 •

edited

Loading

PicoJr commented Apr 18, 2021 •

edited

Loading

ehuss left a comment

PicoJr commented Apr 19, 2021

ehuss commented Apr 19, 2021

ehuss commented Apr 20, 2021

bors commented Apr 20, 2021

bors commented Apr 20, 2021

bors commented Apr 20, 2021

ehuss commented Apr 20, 2021

bors commented Apr 20, 2021

bors commented Apr 20, 2021

bors commented Apr 20, 2021

ehuss commented Apr 20, 2021

Fix #9350 (cargo build -Z help is missing options) #9369

Fix #9350 (cargo build -Z help is missing options) #9369

Conversation

PicoJr commented Apr 17, 2021 • edited Loading

rust-highfive commented Apr 17, 2021

ehuss commented Apr 18, 2021 • edited Loading

PicoJr commented Apr 18, 2021 • edited Loading

ehuss left a comment

Choose a reason for hiding this comment

PicoJr commented Apr 19, 2021

ehuss commented Apr 19, 2021

ehuss commented Apr 20, 2021

bors commented Apr 20, 2021

bors commented Apr 20, 2021

bors commented Apr 20, 2021

ehuss commented Apr 20, 2021

bors commented Apr 20, 2021

bors commented Apr 20, 2021

bors commented Apr 20, 2021

ehuss commented Apr 20, 2021

PicoJr commented Apr 17, 2021 •

edited

Loading

ehuss commented Apr 18, 2021 •

edited

Loading

PicoJr commented Apr 18, 2021 •

edited

Loading