rustdoc: Tracking issue for mergeable cross-crate info
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
This is a tracking issue for the RFC "Mergeable rustdoc cross-crate info" (rust-lang/rfcs#3662).
[!NOTE]
Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.A tracking issue is however not meant for large scale discussion, questions, or bug reports.
Instead, open a dedicated issue for the specific matter or post in the #t-rustdoc Zulip channel.Discussion comments will get marked as off-topic or deleted.
Repeated discussions on the tracking issue may lead to the tracking issue getting locked.
Steps
- Implement the RFC (#129337)
- Add documentation (to Rustdoc Book) -- cc @EtomicBomb
- Stabilization PR (see instructions on rustc-dev-guide)
Unresolved Questions
- Consider removing
--merge=sharedand only allow it by not providing a--mergeflag. This would allow removing the implementation of shared CCI later, once Cargo uses mergeable CCI. https://github.com/rust-lang/rfcs/pull/3662#discussion_r1735147546- resolved: We removed
--mergealtogether, and it's inferred from the presence of the flags for which dirs to read/write from.
- resolved: We removed
- What happens if two rustdoc invocations have the same
--write-doc-meta-dirdirectory? https://github.com/rust-lang/rust/pull/159473#issuecomment-5147472710
Implementation history
- #129337
- #128252
- #128161
- https://github.com/rust-lang/rust/pull/148186
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading RFC 3662 and the stabilization instructions linked in the issue, then review the implementation PRs listed under the completed checklist. The remaining work is a stabilization PR and consideration of concurrent use of the same --write-doc-meta-dir directory; done means the feature is stabilized and that unresolved behavior is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100