Skip to content

Commit d174b77

Browse files
caseycasey
committed
Clarify which values may be used together with --message-format 
1 parent 8fa0827 commit d174b77

28 files changed

+224
-150
lines changed

‎src/doc/man/generated_txt/cargo-bench.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,24 +241,28 @@ OPTIONS
241241
times and consists of comma-separated values. Valid values:
242242

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

245-
o short: Emit shorter, human-readable text messages.
246+
o short: Emit shorter, human-readable text messages. Conflicts with
247+
human and json.
246248

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

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

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

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

263267
Manifest Options
264268
--manifest-path path

‎src/doc/man/generated_txt/cargo-build.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,24 +190,28 @@ OPTIONS
190190
times and consists of comma-separated values. Valid values:
191191

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

194-
o short: Emit shorter, human-readable text messages.
195+
o short: Emit shorter, human-readable text messages. Conflicts with
196+
human and json.
195197

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

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

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

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

212216
--build-plan
213217
Outputs a series of JSON messages to stdout that indicate the

‎src/doc/man/generated_txt/cargo-check.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -194,24 +194,28 @@ OPTIONS
194194
times and consists of comma-separated values. Valid values:
195195

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

198-
o short: Emit shorter, human-readable text messages.
199+
o short: Emit shorter, human-readable text messages. Conflicts with
200+
human and json.
199201

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

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

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

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

216220
Manifest Options
217221
--manifest-path path

‎src/doc/man/generated_txt/cargo-doc.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,24 +156,28 @@ OPTIONS
156156
times and consists of comma-separated values. Valid values:
157157

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

160-
o short: Emit shorter, human-readable text messages.
161+
o short: Emit shorter, human-readable text messages. Conflicts with
162+
human and json.
161163

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

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

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

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

178182
Manifest Options
179183
--manifest-path path

‎src/doc/man/generated_txt/cargo-fix.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -243,24 +243,28 @@ OPTIONS
243243
times and consists of comma-separated values. Valid values:
244244

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

247-
o short: Emit shorter, human-readable text messages.
248+
o short: Emit shorter, human-readable text messages. Conflicts with
249+
human and json.
248250

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

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

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

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

265269
Manifest Options
266270
--manifest-path path

‎src/doc/man/generated_txt/cargo-run.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,24 +111,28 @@ OPTIONS
111111
times and consists of comma-separated values. Valid values:
112112

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

115-
o short: Emit shorter, human-readable text messages.
116+
o short: Emit shorter, human-readable text messages. Conflicts with
117+
human and json.
116118

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

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

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

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

133137
Manifest Options
134138
--manifest-path path

‎src/doc/man/generated_txt/cargo-rustc.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,24 +173,28 @@ OPTIONS
173173
times and consists of comma-separated values. Valid values:
174174

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

177-
o short: Emit shorter, human-readable text messages.
178+
o short: Emit shorter, human-readable text messages. Conflicts with
179+
human and json.
178180

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

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

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

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

195199
Manifest Options
196200
--manifest-path path

‎src/doc/man/generated_txt/cargo-rustdoc.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,24 +180,28 @@ OPTIONS
180180
times and consists of comma-separated values. Valid values:
181181

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

184-
o short: Emit shorter, human-readable text messages.
185+
o short: Emit shorter, human-readable text messages. Conflicts with
186+
human and json.
185187

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

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

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

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

202206
Manifest Options
203207
--manifest-path path

‎src/doc/man/generated_txt/cargo-test.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -263,24 +263,28 @@ OPTIONS
263263
times and consists of comma-separated values. Valid values:
264264

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

267-
o short: Emit shorter, human-readable text messages.
268+
o short: Emit shorter, human-readable text messages. Conflicts with
269+
human and json.
268270

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

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

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

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

285289
Manifest Options
286290
--manifest-path path

‎src/doc/man/includes/options-message-format.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,20 @@
22
The output format for diagnostic messages. Can be specified multiple times
33
and consists of comma-separated values. Valid values:
44

5-
- `human` (default): Display in a human-readable text format.
6-
- `short`: Emit shorter, human-readable text messages.
5+
- `human` (default): Display in a human-readable text format. Conflicts with
6+
`short` and `json`.
7+
- `short`: Emit shorter, human-readable text messages. Conflicts with `human`
8+
and `json`.
79
- `json`: Emit JSON messages to stdout. See
810
[the reference](../reference/external-tools.html#json-messages)
9-
for more details.
11+
for more details. Conflicts with `human` and `short`.
1012
- `json-diagnostic-short`: Ensure the `rendered` field of JSON messages contains
11-
the "short" rendering from rustc.
13+
the "short" rendering from rustc. Cannot be used with `human` or `short`.
1214
- `json-diagnostic-rendered-ansi`: Ensure the `rendered` field of JSON messages
1315
contains embedded ANSI color codes for respecting rustc's default color
14-
scheme.
16+
scheme. Cannot be used with `human` or `short`.
1517
- `json-render-diagnostics`: Instruct Cargo to not include rustc diagnostics in
1618
in JSON messages printed, but instead Cargo itself should render the
1719
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
18-
coming from rustc are still emitted.
20+
coming from rustc are still emitted. Cannot be used with `human` or `short`.
1921
{{/option}}

‎src/doc/src/commands/cargo-bench.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -296,20 +296,22 @@ terminal.</li>
296296
<dd class="option-desc">The output format for diagnostic messages. Can be specified multiple times
297297
and consists of comma-separated values. Valid values:</p>
298298
<ul>
299-
<li><code>human</code> (default): Display in a human-readable text format.</li>
300-
<li><code>short</code>: Emit shorter, human-readable text messages.</li>
299+
<li><code>human</code> (default): Display in a human-readable text format. Conflicts with
300+
<code>short</code> and <code>json</code>.</li>
301+
<li><code>short</code>: Emit shorter, human-readable text messages. Conflicts with <code>human</code>
302+
and <code>json</code>.</li>
301303
<li><code>json</code>: Emit JSON messages to stdout. See
302304
<a href="../reference/external-tools.html#json-messages">the reference</a>
303-
for more details.</li>
305+
for more details. Conflicts with <code>human</code> and <code>short</code>.</li>
304306
<li><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains
305-
the &quot;short&quot; rendering from rustc.</li>
307+
the &quot;short&quot; rendering from rustc. Cannot be used with <code>human</code> or <code>short</code>.</li>
306308
<li><code>json-diagnostic-rendered-ansi</code>: Ensure the <code>rendered</code> field of JSON messages
307309
contains embedded ANSI color codes for respecting rustc's default color
308-
scheme.</li>
310+
scheme. Cannot be used with <code>human</code> or <code>short</code>.</li>
309311
<li><code>json-render-diagnostics</code>: Instruct Cargo to not include rustc diagnostics in
310312
in JSON messages printed, but instead Cargo itself should render the
311313
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
312-
coming from rustc are still emitted.</li>
314+
coming from rustc are still emitted. Cannot be used with <code>human</code> or <code>short</code>.</li>
313315
</ul></dd>
314316

315317

‎src/doc/src/commands/cargo-build.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -244,20 +244,22 @@ terminal.</li>
244244
<dd class="option-desc">The output format for diagnostic messages. Can be specified multiple times
245245
and consists of comma-separated values. Valid values:</p>
246246
<ul>
247-
<li><code>human</code> (default): Display in a human-readable text format.</li>
248-
<li><code>short</code>: Emit shorter, human-readable text messages.</li>
247+
<li><code>human</code> (default): Display in a human-readable text format. Conflicts with
248+
<code>short</code> and <code>json</code>.</li>
249+
<li><code>short</code>: Emit shorter, human-readable text messages. Conflicts with <code>human</code>
250+
and <code>json</code>.</li>
249251
<li><code>json</code>: Emit JSON messages to stdout. See
250252
<a href="../reference/external-tools.html#json-messages">the reference</a>
251-
for more details.</li>
253+
for more details. Conflicts with <code>human</code> and <code>short</code>.</li>
252254
<li><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains
253-
the &quot;short&quot; rendering from rustc.</li>
255+
the &quot;short&quot; rendering from rustc. Cannot be used with <code>human</code> or <code>short</code>.</li>
254256
<li><code>json-diagnostic-rendered-ansi</code>: Ensure the <code>rendered</code> field of JSON messages
255257
contains embedded ANSI color codes for respecting rustc's default color
256-
scheme.</li>
258+
scheme. Cannot be used with <code>human</code> or <code>short</code>.</li>
257259
<li><code>json-render-diagnostics</code>: Instruct Cargo to not include rustc diagnostics in
258260
in JSON messages printed, but instead Cargo itself should render the
259261
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
260-
coming from rustc are still emitted.</li>
262+
coming from rustc are still emitted. Cannot be used with <code>human</code> or <code>short</code>.</li>
261263
</ul></dd>
262264

263265

0 commit comments

Comments
 (0)