Skip to content

Commit e55600b

Browse files
committed
Auto merge of #7595 - ehuss:doc-json, r=Eh2406
Document Cargo's JSON output. This adds some documentation explaining Cargo's `--message-format=json` output.
2 parents 4aa17ed + a280f8a commit e55600b

20 files changed

+246
-72
lines changed

src/doc/man/generated/cargo-bench.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,9 @@ <h3 id="cargo_bench_display_options">Display Options</h3>
321321
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
322322
</li>
323323
<li>
324-
<p><code>json</code>: Emit JSON messages to stdout.</p>
324+
<p><code>json</code>: Emit JSON messages to stdout. See
325+
<a href="../reference/external-tools.html#json-messages">the reference</a>
326+
for more details.</p>
325327
</li>
326328
<li>
327329
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/generated/cargo-build.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,9 @@ <h3 id="cargo_build_display_options">Display Options</h3>
255255
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
256256
</li>
257257
<li>
258-
<p><code>json</code>: Emit JSON messages to stdout.</p>
258+
<p><code>json</code>: Emit JSON messages to stdout. See
259+
<a href="../reference/external-tools.html#json-messages">the reference</a>
260+
for more details.</p>
259261
</li>
260262
<li>
261263
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/generated/cargo-check.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,9 @@ <h3 id="cargo_check_display_options">Display Options</h3>
257257
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
258258
</li>
259259
<li>
260-
<p><code>json</code>: Emit JSON messages to stdout.</p>
260+
<p><code>json</code>: Emit JSON messages to stdout. See
261+
<a href="../reference/external-tools.html#json-messages">the reference</a>
262+
for more details.</p>
261263
</li>
262264
<li>
263265
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/generated/cargo-doc.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,9 @@ <h3 id="cargo_doc_display_options">Display Options</h3>
227227
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
228228
</li>
229229
<li>
230-
<p><code>json</code>: Emit JSON messages to stdout.</p>
230+
<p><code>json</code>: Emit JSON messages to stdout. See
231+
<a href="../reference/external-tools.html#json-messages">the reference</a>
232+
for more details.</p>
231233
</li>
232234
<li>
233235
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/generated/cargo-fix.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,9 @@ <h3 id="cargo_fix_display_options">Display Options</h3>
328328
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
329329
</li>
330330
<li>
331-
<p><code>json</code>: Emit JSON messages to stdout.</p>
331+
<p><code>json</code>: Emit JSON messages to stdout. See
332+
<a href="../reference/external-tools.html#json-messages">the reference</a>
333+
for more details.</p>
332334
</li>
333335
<li>
334336
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/generated/cargo-run.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,9 @@ <h3 id="cargo_run_display_options">Display Options</h3>
179179
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
180180
</li>
181181
<li>
182-
<p><code>json</code>: Emit JSON messages to stdout.</p>
182+
<p><code>json</code>: Emit JSON messages to stdout. See
183+
<a href="../reference/external-tools.html#json-messages">the reference</a>
184+
for more details.</p>
183185
</li>
184186
<li>
185187
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/generated/cargo-rustc.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,9 @@ <h3 id="cargo_rustc_display_options">Display Options</h3>
240240
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
241241
</li>
242242
<li>
243-
<p><code>json</code>: Emit JSON messages to stdout.</p>
243+
<p><code>json</code>: Emit JSON messages to stdout. See
244+
<a href="../reference/external-tools.html#json-messages">the reference</a>
245+
for more details.</p>
244246
</li>
245247
<li>
246248
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/generated/cargo-rustdoc.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,9 @@ <h3 id="cargo_rustdoc_display_options">Display Options</h3>
255255
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
256256
</li>
257257
<li>
258-
<p><code>json</code>: Emit JSON messages to stdout.</p>
258+
<p><code>json</code>: Emit JSON messages to stdout. See
259+
<a href="../reference/external-tools.html#json-messages">the reference</a>
260+
for more details.</p>
259261
</li>
260262
<li>
261263
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/generated/cargo-test.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,9 @@ <h3 id="cargo_test_display_options">Display Options</h3>
346346
<p><code>short</code>: Emit shorter, human-readable text messages.</p>
347347
</li>
348348
<li>
349-
<p><code>json</code>: Emit JSON messages to stdout.</p>
349+
<p><code>json</code>: Emit JSON messages to stdout. See
350+
<a href="../reference/external-tools.html#json-messages">the reference</a>
351+
for more details.</p>
350352
</li>
351353
<li>
352354
<p><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains

src/doc/man/options-message-format.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
+
55
- `human` (default): Display in a human-readable text format.
66
- `short`: Emit shorter, human-readable text messages.
7-
- `json`: Emit JSON messages to stdout.
7+
- `json`: Emit JSON messages to stdout. See
8+
linkcargo:reference/external-tools.html#json-messages[the reference]
9+
for more details.
810
- `json-diagnostic-short`: Ensure the `rendered` field of JSON messages contains
911
the "short" rendering from rustc.
1012
- `json-diagnostic-rendered-ansi`: Ensure the `rendered` field of JSON messages

0 commit comments

Comments
 (0)