feat: Add --output-format=json to cargo doc as an unstable option#17025
Open
LukeMathWalker wants to merge 1 commit into
Open
feat: Add --output-format=json to cargo doc as an unstable option#17025LukeMathWalker wants to merge 1 commit into
LukeMathWalker wants to merge 1 commit into
Conversation
a836d85 to
13c5949
Compare
Member
|
cc #13283 |
Author
|
cc @aDotInTheVoid for visibility. |
Collaborator
|
r? @weihanglo rustbot has assigned @weihanglo. Use Why was this reviewer chosen?The reviewer was selected based on:
|
This file contains hidden or 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
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?
In #13283, the issue of naming conflict between doc artefacts was raised as a reason to wait before adding
--output-formatsupport tocargo doc.Given the changes in #16773, I argue we shouldn't treat that oustanding design question as a blocker: since JSON doc output is now locked in to use the new build directory layout, we get benefits from first-class support in
cargo doceven if the conflicts in the target directory remain unresolved.Namely, it becomes possible to compute the JSON docs for the whole workspace at once and then retrieve the artefacts directly from the build directory. This would significantly speed up tools like cheadergen when launched on workspaces that inevitably have multiple versions of the same crate in their dependency tree.
How to test and review this PR?
I followed the same testing approach used in #16773 to ease review. Happy to add more test cases if we deem they are necessary.