Skip to content
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

librustdoc no longer part of distributable #43729

Closed
nrc opened this issue Aug 8, 2017 · 10 comments
Closed

librustdoc no longer part of distributable #43729

nrc opened this issue Aug 8, 2017 · 10 comments
Labels
C-bug Category: This is a bug. disposition-close This PR / issue is in PFCP or FCP with a disposition to close it. finished-final-comment-period The final comment period is finished for this PR / Issue. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@nrc
Copy link
Member

nrc commented Aug 8, 2017

librustdoc used to be distributed with other compiler crates and could be found in the sysroot. This is no longer the case which breaks any crate which does extern crate rustdoc;.

I assume this wasn't intentional and is due to the changes with how rustdoc is being built.

cc @Mark-Simulacrum @alexcrichton

@nrc nrc added T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. labels Aug 8, 2017
@alexcrichton
Copy link
Member

Hm this was indeed intentional, all due to #43482. That being said, it wasn't intended to break things!

@nrc did you have tools using extern crate rustdoc out of tree? That's sort of something I'd hope that we wouldn't have to keep working :(

@Mark-Simulacrum
Copy link
Member

Yes, this was indeed intentional. We can technically fix this I think if we need to, but I'd prefer not to -- it'd be a bit of a hack.

@nrc
Copy link
Member Author

nrc commented Aug 8, 2017

did you have tools using extern crate rustdoc out of tree?

Yes, rustw does. It only uses its markdown rendering though. I'd assume I could pull that into an external crate, but iirc, the last time I tried that it was tied into rustdoc and compiler internals in weird ways.

I'll look into that - I assume Steve will have to solve a similar problem for new rustdoc, so maybe I can use that?

@Mark-Simulacrum
Copy link
Member

Well, if it's not working out to migrate to either the new rustdoc or otherwise solve the problem, let us know and we can discuss making librustdoc remain in the sysroot.

@Mark-Simulacrum Mark-Simulacrum added C-bug Category: This is a bug. I-needs-decision Issue: In need of a decision. labels Aug 10, 2017
@Mark-Simulacrum Mark-Simulacrum removed I-needs-decision Issue: In need of a decision. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. labels Sep 15, 2017
@Mark-Simulacrum
Copy link
Member

@rfcbot fcp close

Let's see if this works...

If not, I'll just close; I don't think this is going to change. rustdoc is unstable, and shouldn't really be used for markdown rendering anyway...

@rfcbot
Copy link

rfcbot commented Sep 15, 2017

Team member @Mark-Simulacrum has proposed to close this. The next step is review by the rest of the tagged teams:

No concerns currently listed.

Once a majority of reviewers approve (and none object), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

@rfcbot rfcbot added the proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. label Sep 15, 2017
@steveklabnik
Copy link
Member

I assume Steve will have to solve a similar problem for new rustdoc

I was planning on publishing on crates.io, honestly.

@rfcbot
Copy link

rfcbot commented Feb 16, 2018

🔔 This is now entering its final comment period, as per the review above. 🔔

@rfcbot rfcbot added final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. and removed proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. labels Feb 16, 2018
@rfcbot
Copy link

rfcbot commented Feb 26, 2018

The final comment period is now complete.

@Centril Centril added finished-final-comment-period The final comment period is finished for this PR / Issue. disposition-close This PR / issue is in PFCP or FCP with a disposition to close it. and removed final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. labels May 24, 2018
@Mark-Simulacrum
Copy link
Member

Closing as per concluded FCP.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. disposition-close This PR / issue is in PFCP or FCP with a disposition to close it. finished-final-comment-period The final comment period is finished for this PR / Issue. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

6 participants