Skip to content

Commit 192f7f1

Browse files
committed
docs: tools should only interpret a line starting with { as JSON
1 parent e8adba9 commit 192f7f1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/doc/src/reference/external-tools.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ The `package_id` field is a unique identifier for referring to the package, and
4646
as the `--package` argument to many commands. The syntax grammar can be found in
4747
chapter [Package ID Specifications].
4848

49+
> **Note:** Not all output is guaranteed to be in JSON format with the `--message-format=json` option.
50+
> For example, output from procedural macros and logs from external tools may appear in plain text.
51+
> Tools should only interpret a line as JSON if it starts with `{`.
52+
4953
The `--message-format` option can also take additional formatting values which
5054
alter the way the JSON messages are computed and rendered. See the description
5155
of the `--message-format` option in the [build command documentation] for more

0 commit comments

Comments
 (0)