Skip to content
This repository has been archived by the owner on May 20, 2020. It is now read-only.

Rustdoc only works on crates using the nightly compiler #95

Open
mgattozzi opened this issue Aug 1, 2017 · 9 comments
Open

Rustdoc only works on crates using the nightly compiler #95

mgattozzi opened this issue Aug 1, 2017 · 9 comments

Comments

@mgattozzi
Copy link
Contributor

mgattozzi commented Aug 1, 2017

I tried running this on my stable crate github-rs and it failed becausse it couldn't generate the analysis.
The reason is because we use the -Z option to pass in to cargo. This option now only works on nightly.
However, with rustup that directory is set to stable rust so the version of cargo called there is the stable version which doesn't work with -Z causing the failure.

EDIT:

@mgattozzi
Copy link
Contributor Author

I think the solution is to use cargo as dependency like RLS and just invoke the build as a Rust function to bypass this issue. I'll experiment with this.

@mgattozzi
Copy link
Contributor Author

And if not we need to get this stabilized somehow in rustc because otherwise this is kind of useless to stable users.

@steveklabnik
Copy link
Owner

If we use cargo as a dep, then we're tied to that exact version of Cargo...

And if not we need to get this stabilized somehow in rustc

There's plans in place for this, it's going to be a while though.

@mgattozzi
Copy link
Contributor Author

If it's going to be a while it seems counter to the whole impl period which says that it wants to get:

New rustdoc at parity with existing rustdoc, and starting to explore new design space

I would think this is a huge blocker to that goal.

@steveklabnik
Copy link
Owner

@nrc would know better about when rls-analysis is likely to be supported on stable.

@mgattozzi
Copy link
Contributor Author

Awesome! :D Looking forward to that answer.

@nrc
Copy link

nrc commented Aug 1, 2017

I think the solution is to use cargo as dependency like RLS

I think you would need to link the compiler too and copy the machinery in the RLS for actually using all that stuff. I would not recommend doing this.

@nrc would know better about when rls-analysis is likely to be supported on stable.

RLS is meant to be riding the trains this cycle but is blocked on some implementation effort (by me).

There is also the question of stabilising -Zsave-analysis. The idea has been tossed around a little bit, but I haven't started a formal discussion (I'll do that today - we need this for the RLS too)

@mgattozzi
Copy link
Contributor Author

Thanks for the reply @nrc!

@steveklabnik
Copy link
Owner

Small update here, rls-preview is now available on stable. But that's about it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants