-
Notifications
You must be signed in to change notification settings - Fork 71
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.
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
Add a new --crate-version
flag to rustc
#622
Comments
This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed. cc @rust-lang/compiler @rust-lang/compiler-contributors |
@rustbot second |
@rustbot label -final-comment-period +major-change-accepted |
reverting the closing to let some time to discuss the design |
This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed. cc @rust-lang/compiler @rust-lang/compiler-contributors |
Closed in favour of #635 |
Proposal
The problem
rustdoc
relies on its--crate-version
flag to know the version of the crate it is generating documentation for.There is no equivalent source of information, though, for the version of its dependencies.
This causes issues when multiple versions of the same crate are listed as direct dependencies (via renames) of the crate we are documenting—e.g. it becomes impossible to find out where items are coming from.
The proposed solution
Add a
--crate-version
flag torustc
.The value would be provided by
cargo
and then captured as part of the .rlib metadata, which would in turn make it available torustdoc
, as well as other parts of the compiler that might benefit from it (e.g. diagnostics, such as version mismatches which currently limit themselves toperhaps two different version of CRATE_NAME are being used?
).Mentors or Reviewers
A mentor would definitely be appreciated, I never touched any of the code involved here.
Process
The main points of the [Major Change Process][MCP] are as follows:
@rustbot second
.-C flag
, then full team check-off is required.@rfcbot fcp merge
on either the MCP or the PR.Comments
This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.
The text was updated successfully, but these errors were encountered: