Stabilize future-incompat-report

[Aaron1011]

Depends on rust-lang/rust#91535

[rust-highfive]

r? @ehuss

(rust-highfive has picked a reviewer for you, use r? to override)

[ehuss]

Thanks!

Can you update the documentation? What I can see:

• Remove this section from unstable.md, and create a ### future incompat report at the bottom of the page in the form of the other stabilized features.
  • And remove this line at the top.
• Add a cargo report man page:
  • Add a page to https://github.com/rust-lang/cargo/tree/master/src/doc/man in the same form as the other pages. This is the first command with subcommands (I think), so we're treading new ground here. But I think just having one man page with a section for each subcommand would be fine (and there's only one subcommand right now).
  • Add the page to https://github.com/rust-lang/cargo/blob/master/src/doc/src/SUMMARY.md. Probably to the "build commands". The categorization of commands unfortunately isn't great.
  • Add the page to https://github.com/rust-lang/cargo/blob/master/src/doc/src/commands/build-commands.md
• Add documentation to every command that takes --future-incompat-report:
  • Document it once in a file added to https://github.com/rust-lang/cargo/tree/master/src/doc/man/includes. I would probably provide a short description, and then link to the cargo-report man page for more details.
  • In each command, reference that file with {{> options-future-incompat }} which I think should go in the "Display Options" section probably?

Instructions to rebuild the man pages are at https://github.com/rust-lang/cargo/tree/master/src/doc/. More documentation on the man page templates is at https://github.com/rust-lang/cargo/blob/master/crates/mdman/doc/out/mdman.md.

[Aaron1011]

@ehuss I've updated the docs - let me know if you want any changes.

The nightly tests will begin passing tomorrow, once rust-lang/rust#91535 makes it into a nightly build.

[ehuss]

Can this include a link to the new future-incompat chapter? IIRC, just a relative link like [foo](../reference/future-incompat-report.html) should.

[Aaron1011]

I added a link in the "See also" section

[ehuss]

Looks great!

I forgot that this adds new configuration options. Can you update https://github.com/rust-lang/cargo/blob/master/src/doc/src/reference/config.md to include the new table? It should be included in the example at the top, and then the fields should be documented below (it's alphabetized IIRC). And then add the corresponding environment variables to https://github.com/rust-lang/cargo/blob/master/src/doc/src/reference/environment-variables.md#configuration-environment-variables.

[Aaron1011]

@ehuss: I've added documentation for the new config options (there's no corresponding environment variable). The tests are now passing since the latest nightly supports --json future-incompat.

[ehuss]

The environment variables are automatically part of the config system, so in this case it is CARGO_FUTURE_INCOMPAT_REPORT_FREQUENCY.

[Aaron1011]

@ehuss Updated

[ehuss]

Thanks!!!

@bors r+

[bors]

📌 Commit 673b15d has been approved by ehuss

[bors]

⌛ Testing commit 673b15d with merge 263b169...

[bors]

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