docs: tools should only interpret a line starting with { as JSON
#14677
+6
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
A-documenting-cargo-itself
epage
reviewed
Oct 11, 2024
Comment on lines
49
to
54
| > **Note:** Not all output is guaranteed to be in JSON format with the `--message-format=json` option. | ||
| > For example, output from procedural macros and logs from external tools may appear in plain text. | ||
| > Tools should only interpret a line as JSON if it starts with `{`. | ||
|
|
There was a problem hiding this comment.
I think I'd prefer we don't bless mixed output as much as this makes it sound like it.
Maybe instead
Suggested change
| > **Note:** Not all output is guaranteed to be in JSON format with the `--message-format=json` option. | |
| > For example, output from procedural macros and logs from external tools may appear in plain text. | |
| > Tools should only interpret a line as JSON if it starts with `{`. | |
| > **Note:** `--message-format=json` only controls Cargo and Rustc's output. This cannot control the output of other tools, e.g. `cargo run --message-format=json`. A possible workaround in these situations is to only interpret a line as JSON if it starts with `{`. | |
There was a problem hiding this comment.
Applied your suggestion with a mention of proc macros. I think it is still worth since proc macros are not seen as “other tools” and people may not realize immediately.
weihanglo
force-pushed
the
message-format
branch
from
192f7f1
to
402cb17
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
Minor doc improvement that helps #8179
How should we test and review this PR?
Additional information