Skip to content

feat(rustdoc): stabilize --emit flag #146220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(rustdoc): stabilize --emit flag #146220

wants to merge 1 commit into from
+30 −1

Conversation

weihanglo
Copy link
Member

TODO: stabilization report?

r? rustdoc

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Sep 5, 2025
@weihanglo
Copy link
Member Author

Questions:

  • Do we want to stabilize also unversioned-shared-resources option? It currently does nothing AFAIK.
  • Do we want a stabilization report?
  • How many details do we want to put in doc?

@weihanglo
Copy link
Member Author

cc @aDotInTheVoid since you've involved in the PR removing the last blocker :)

@weihanglo weihanglo marked this pull request as ready for review September 24, 2025 19:21
@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 24, 2025
@fmease fmease added the needs-fcp This change is insta-stable, or significant enough to need a team FCP to proceed. label Oct 13, 2025
fmease
fmease reviewed Oct 13, 2025
View reviewed changes
src/doc/rustdoc/src/command-line-arguments.md
Comment on lines +459 to +461
filename is `CRATE_NAME.d`. This emit type can can optionally be followed by
`=` to specify an explicit output path.
For example, `--emit=dep-info=/path/to/foo.d`.
Copy link
Member

@fmease fmease Oct 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found a bug: rustdoc's --emit=dep-info=- doesn't output to STDOUT unlike rustc's.

Edit: This ought to be addressed in a separate PR by someone. I'll probably open an issue later to track this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened #147649 (blocking the stabilization IMO).

@notriddle notriddle self-assigned this Oct 13, 2025
@GuillaumeGomez
Copy link
Member

We discussed on today's rustdoc meeting. Before going any further, we will investigate exactly what each --emit option does exactly to have a clearer picture of what's actually needed and also to add missing documentation.

@fmease fmease mentioned this pull request Oct 13, 2025
Closed
@weihanglo
Copy link
Member Author

We discussed on today's rustdoc meeting. Before going any further, we will investigate exactly what each --emit option does exactly to have a clearer picture of what's actually needed and also to add missing documentation.

Thanks for it!

This PR contains a doc based on my understanding and the history of these options, but I am not 100% sure if that is correct

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fmease fmease fmease left review comments

Assignees

@notriddle notriddle

@GuillaumeGomez GuillaumeGomez

Labels

needs-fcp This change is insta-stable, or significant enough to need a team FCP to proceed. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@weihanglo @GuillaumeGomez @fmease @notriddle @rustbot