CARGO-REPO...ATIBILITIES(1)

📦 version 1.96.1, in ubuntu stonking

✨ cargo-report-future-incompatibilities(1) ✨

okay bestie, buckle up, this is a page from the General Commands Manual and it's giving "your build is fine for now but the compiler is side-eyeing you" 💅

💖 NAME 💖

cargo-report-future-incompatibilities — the lil command that reports any crates which will eventually stop compiling 😭

🌸 SYNOPSIS 🌸

cargo report future-incompatibilities [options]

🦋 DESCRIPTION 🦋

So what it does: it displays a report of future-incompatible warnings that were emitted during previous builds. These are warnings for changes that may become hard errors in the future, which would make dependencies stop building in a future version of rustc. it's giving "the vibes are off and the compiler is literally telling you in advance" 💀

For more, see the chapter on Future incompat report — https://doc.rust-lang.org/cargo/reference/future-incompat-report.html 📖

✨ OPTIONS ✨

  • --id id — show the report with the specified Cargo-generated id. If you don't specify one, it shows the most recent report. default behaviour, main character energy 👑

🎀 Package Selection 🎀

By default, the package in the current working directory is selected. The -p flag can be used to choose a different package in a workspace. no cap 🫶

  • -p spec, --package spec — the package to display a report for. See cargo-pkgid(1) for the SPEC format.

💜 Display Options 💜

  • -v, --verbose — use verbose output. May be specified twice for "very verbose" output, which includes extra output such as dependency warnings and build script output. May also be specified with the term.verbose config value — https://doc.rust-lang.org/cargo/reference/config.html. okay so twice is the move if you want the whole lore 😤
  • -q, --quiet — do not print cargo log messages. May also be specified with the term.quiet config value — https://doc.rust-lang.org/cargo/reference/config.html. shhh 🤫
  • --color when — control when colored output is used. Valid values are:
    • auto (default): automatically detect if color support is available on the terminal.
    • always: always display colors. 🌈
    • never: never display colors. 💀

May also be specified with the term.color config value — https://doc.rust-lang.org/cargo/reference/config.html.

🧚 Manifest Options 🧚

  • --locked — asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:
    • The lock file is missing. 😭
    • Cargo attempted to change the lock file due to a different dependency resolution.

It may be used in environments where deterministic builds are desired, such as in CI pipelines. periodt, reproducibility is iconic ✨

  • --offline — prevents Cargo from accessing the network for any reason. Without this flag, Cargo will stop with an error if it needs to access the network and the network is not available. With this flag, Cargo will attempt to proceed without the network if possible. airplane mode but for crates ✈️
Beware that this may result in different dependency resolution than online mode. Cargo will restrict itself to crates that are downloaded locally, even if there might be a newer version as indicated in the local copy of the index. See the cargo-fetch(1) command to download dependencies before going offline.

May also be specified with the net.offline config value — https://doc.rust-lang.org/cargo/reference/config.html.

  • --frozen — equivalent to specifying both --locked and --offline. it's giving combo deal 🍓

👑 Common Options 👑

  • +toolchain — if Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). See the rustup documentation — https://rust-lang.github.io/rustup/overrides.html — for more information about how toolchain overrides work.
  • --config KEY=VALUE or PATH — overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section — https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides — for more information.
  • -C PATH — changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must appear before the command name, for example cargo -C path/to/my-project build. order matters bestie, don't do it wrong 🙈
This option is only available on the nightly channel — https://doc.rust-lang.org/book/appendix-07-nightly-rust.html — and requires the -Z unstable-options flag to enable (see #10098 — https://github.com/rust-lang/cargo/issues/10098).
  • -h, --help — prints help information. your emergency contact 🫶
  • -Z flag — unstable (nightly-only) flags to Cargo. Run cargo -Z help for details. chaos mode, but make it official 💅

🌈 ENVIRONMENT 🌈

See the reference — https://doc.rust-lang.org/cargo/reference/environment-variables.html — for details on environment variables that Cargo reads. env vars are lowkey the whole personality of a build 🌸

⭐ EXIT STATUS ⭐

  • 0: Cargo succeeded. slay 💖
  • 101: Cargo failed to complete. crying 😭

🎀 EXAMPLES 🎀

  1. Display the latest future-incompat report:
cargo report future-incompat
  1. Display the latest future-incompat report for a specific package:
cargo report future-incompat --package my-dep@0.0.1

💜 SEE ALSO 💜

cargo(1), cargo-report(1), cargo-build(1) — the friend group, go say hi 🫶

okay that's the whole page, you ate that. this is CARGO-REPO...ATIBILITIES(1) from the General Commands Manual, and yeah the title really is that long, the header is just the page name echoing back at you like a vibe check. no version number, no date, just the man page name twice because that's the format, iykyk. go fix your future incompatibilities bestie, ily 💅✨🎀

📦 where this page comes from