src/tools/cargo/src/doc/src/commands/cargo-report.md

   1 # cargo-report(1)
   2
   3 ## NAME
   4
   5 cargo-report --- Generate and display various kinds of reports
   6
   7 ## SYNOPSIS
   8
   9 `cargo report` _type_ [_options_]
  10
  11 ### DESCRIPTION
  12
  13 Displays a report of the given _type_ --- currently, only `future-incompat` is supported
  14
  15 ## OPTIONS
  16
  17 <dl>
  18
  19 <dt class="option-term" id="option-cargo-report---id"><a class="option-anchor" href="#option-cargo-report---id"></a><code>--id</code> <em>id</em></dt>
  20 <dd class="option-desc">Show the report with the specified Cargo-generated id</dd>
  21
  22
  23 <dt class="option-term" id="option-cargo-report--p"><a class="option-anchor" href="#option-cargo-report--p"></a><code>-p</code> <em>spec</em>…</dt>
  24 <dt class="option-term" id="option-cargo-report---package"><a class="option-anchor" href="#option-cargo-report---package"></a><code>--package</code> <em>spec</em>…</dt>
  25 <dd class="option-desc">Only display a report for the specified package</dd>
  26
  27
  28 </dl>
  29
  30 ## EXAMPLES
  31
  32 1. Display the latest future-incompat report:
  33
  34        cargo report future-incompat
  35
  36 2. Display the latest future-incompat report for a specific package:
  37
  38        cargo report future-incompat --package my-dep:0.0.1
  39
  40 ## SEE ALSO
  41 [Future incompat report](../reference/future-incompat-report.html)
  42
  43 [cargo(1)](cargo.html)