rustdoc-json: Make -o/--output control file, not directory
#149365
+93
−60
Conversation
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
Historically in rustdoc, `-o`, `--out-dir` and `--output` all controlled the output directory, as rustdoc produced many HTML files, so it didn't make sense to give the path to an individual one. This doesn't make sense for rustdoc-json, where only a single file is produced. This commit makes `-o`/`--output` give a path to a file, rather than a directory. `--out-dir` is uneffected. This commit doesn't effect the HTML behaviour. Works towards https://www.github.com/rust-lang/rust/issues/142370 and https://www.github.com/rust-lang/cargo/issues/16291. Zulip Discussion: https://rust-lang.zulipchat.com/#narrow/channel/246057-t-cargo/topic/rustdoc-json.20output.20filename.20design/with/560468799
Collaborator
|
Some changes occurred in src/tools/compiletest cc @jieyouxu |
rustbot
added
A-compiletest
rustbot
added
S-waiting-on-author
This comment has been minimized.
This comment has been minimized.
weihanglo
reviewed
Nov 27, 2025
Member
There was a problem hiding this comment.
Having an alternative here: #83784 (comment).
What about we expanding --emit to have per-emit-type output path. That is pretty similar to rustc --emit. Having a similar behavior across for the same CLI options could be a win and lower the learning cost. That we also can cut off two CLI options (--output-format and this --output options)
Member
Author
There was a problem hiding this comment.
Hmmm, that's worth at least considering. It might also resolve that --output-format=json is used both for "major mode" settings like json and doctest, but also "minor mode" like when giving doc-coverage information.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Historically in rustdoc,
-o,--out-dirand--outputall controlled the output directory, as rustdoc produced many HTML files, so it didn't make sense to give the path to an individual one.This doesn't make sense for rustdoc-json, where only a single file is produced. This commit makes
-o/--outputgive a path to a file, rather than a directory.--out-diris uneffected. This commit doesn't effect the HTML behaviour.Works towards #142370 and rust-lang/cargo#16291. Zulip Discussion: https://rust-lang.zulipchat.com/#narrow/channel/246057-t-cargo/topic/rustdoc-json.20output.20filename.20design/with/560468799
r? @GuillaumeGomez CC @weihanglo
TODO