Skip to content

Commit

Permalink
Auto merge of #9173 - casey:patch-2, r=ehuss
Browse files Browse the repository at this point in the history
Remove mention of --message-format taking multiple values

I tried passing multiple values to `--message-format`, as is mentioned in the docs, and it didn't work:

```
$ cargo test --message-format human,json
error: cannot specify two kinds of `message-format` arguments
$ cargo test --message-format human --message-format json
error: cannot specify two kinds of `message-format` arguments
````

It's entirely possible I misunderstood the docs, but just in case I didn't, I thought I'd open this PR to remove the bit that mentions that the flag accepts multiple values.
  • Loading branch information
bors committed Feb 15, 2021
2 parents af564b2 + d174b77 commit 3e25c9d
Show file tree
Hide file tree
Showing 28 changed files with 224 additions and 150 deletions.
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-bench.txt
Original file line number Diff line number Diff line change
Expand Up @@ -241,24 +241,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

Manifest Options
--manifest-path path
Expand Down
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -190,24 +190,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

--build-plan
Outputs a series of JSON messages to stdout that indicate the
Expand Down
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-check.txt
Original file line number Diff line number Diff line change
Expand Up @@ -194,24 +194,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

Manifest Options
--manifest-path path
Expand Down
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -156,24 +156,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

Manifest Options
--manifest-path path
Expand Down
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-fix.txt
Original file line number Diff line number Diff line change
Expand Up @@ -243,24 +243,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

Manifest Options
--manifest-path path
Expand Down
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-run.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,24 +111,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

Manifest Options
--manifest-path path
Expand Down
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-rustc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -173,24 +173,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

Manifest Options
--manifest-path path
Expand Down
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-rustdoc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -180,24 +180,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

Manifest Options
--manifest-path path
Expand Down
12 changes: 8 additions & 4 deletions src/doc/man/generated_txt/cargo-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -263,24 +263,28 @@ OPTIONS
times and consists of comma-separated values. Valid values:

o human (default): Display in a human-readable text format.
Conflicts with short and json.

o short: Emit shorter, human-readable text messages.
o short: Emit shorter, human-readable text messages. Conflicts with
human and json.

o json: Emit JSON messages to stdout. See the reference
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
for more details.
for more details. Conflicts with human and short.

o json-diagnostic-short: Ensure the rendered field of JSON messages
contains the "short" rendering from rustc.
contains the "short" rendering from rustc. Cannot be used with
human or short.

o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
messages contains embedded ANSI color codes for respecting
rustc's default color scheme.
rustc's default color scheme. Cannot be used with human or short.

o json-render-diagnostics: Instruct Cargo to not include rustc
diagnostics in in JSON messages printed, but instead Cargo itself
should render the JSON diagnostics coming from rustc. Cargo's own
JSON diagnostics and others coming from rustc are still emitted.
Cannot be used with human or short.

Manifest Options
--manifest-path path
Expand Down
14 changes: 8 additions & 6 deletions src/doc/man/includes/options-message-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@
The output format for diagnostic messages. Can be specified multiple times
and consists of comma-separated values. Valid values:

- `human` (default): Display in a human-readable text format.
- `short`: Emit shorter, human-readable text messages.
- `human` (default): Display in a human-readable text format. Conflicts with
`short` and `json`.
- `short`: Emit shorter, human-readable text messages. Conflicts with `human`
and `json`.
- `json`: Emit JSON messages to stdout. See
[the reference](../reference/external-tools.html#json-messages)
for more details.
for more details. Conflicts with `human` and `short`.
- `json-diagnostic-short`: Ensure the `rendered` field of JSON messages contains
the "short" rendering from rustc.
the "short" rendering from rustc. Cannot be used with `human` or `short`.
- `json-diagnostic-rendered-ansi`: Ensure the `rendered` field of JSON messages
contains embedded ANSI color codes for respecting rustc's default color
scheme.
scheme. Cannot be used with `human` or `short`.
- `json-render-diagnostics`: Instruct Cargo to not include rustc diagnostics in
in JSON messages printed, but instead Cargo itself should render the
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
coming from rustc are still emitted.
coming from rustc are still emitted. Cannot be used with `human` or `short`.
{{/option}}
14 changes: 8 additions & 6 deletions src/doc/src/commands/cargo-bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,20 +296,22 @@ terminal.</li>
<dd class="option-desc">The output format for diagnostic messages. Can be specified multiple times
and consists of comma-separated values. Valid values:</p>
<ul>
<li><code>human</code> (default): Display in a human-readable text format.</li>
<li><code>short</code>: Emit shorter, human-readable text messages.</li>
<li><code>human</code> (default): Display in a human-readable text format. Conflicts with
<code>short</code> and <code>json</code>.</li>
<li><code>short</code>: Emit shorter, human-readable text messages. Conflicts with <code>human</code>
and <code>json</code>.</li>
<li><code>json</code>: Emit JSON messages to stdout. See
<a href="../reference/external-tools.html#json-messages">the reference</a>
for more details.</li>
for more details. Conflicts with <code>human</code> and <code>short</code>.</li>
<li><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains
the &quot;short&quot; rendering from rustc.</li>
the &quot;short&quot; rendering from rustc. Cannot be used with <code>human</code> or <code>short</code>.</li>
<li><code>json-diagnostic-rendered-ansi</code>: Ensure the <code>rendered</code> field of JSON messages
contains embedded ANSI color codes for respecting rustc's default color
scheme.</li>
scheme. Cannot be used with <code>human</code> or <code>short</code>.</li>
<li><code>json-render-diagnostics</code>: Instruct Cargo to not include rustc diagnostics in
in JSON messages printed, but instead Cargo itself should render the
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
coming from rustc are still emitted.</li>
coming from rustc are still emitted. Cannot be used with <code>human</code> or <code>short</code>.</li>
</ul></dd>


Expand Down
14 changes: 8 additions & 6 deletions src/doc/src/commands/cargo-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,20 +244,22 @@ terminal.</li>
<dd class="option-desc">The output format for diagnostic messages. Can be specified multiple times
and consists of comma-separated values. Valid values:</p>
<ul>
<li><code>human</code> (default): Display in a human-readable text format.</li>
<li><code>short</code>: Emit shorter, human-readable text messages.</li>
<li><code>human</code> (default): Display in a human-readable text format. Conflicts with
<code>short</code> and <code>json</code>.</li>
<li><code>short</code>: Emit shorter, human-readable text messages. Conflicts with <code>human</code>
and <code>json</code>.</li>
<li><code>json</code>: Emit JSON messages to stdout. See
<a href="../reference/external-tools.html#json-messages">the reference</a>
for more details.</li>
for more details. Conflicts with <code>human</code> and <code>short</code>.</li>
<li><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains
the &quot;short&quot; rendering from rustc.</li>
the &quot;short&quot; rendering from rustc. Cannot be used with <code>human</code> or <code>short</code>.</li>
<li><code>json-diagnostic-rendered-ansi</code>: Ensure the <code>rendered</code> field of JSON messages
contains embedded ANSI color codes for respecting rustc's default color
scheme.</li>
scheme. Cannot be used with <code>human</code> or <code>short</code>.</li>
<li><code>json-render-diagnostics</code>: Instruct Cargo to not include rustc diagnostics in
in JSON messages printed, but instead Cargo itself should render the
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
coming from rustc are still emitted.</li>
coming from rustc are still emitted. Cannot be used with <code>human</code> or <code>short</code>.</li>
</ul></dd>


Expand Down
Loading

0 comments on commit 3e25c9d

Please sign in to comment.