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

Compiler panics on 'cargo doc' #36

Closed
ytmhub opened this issue Jun 21, 2019 · 3 comments · Fixed by #40
Closed

Compiler panics on 'cargo doc' #36

ytmhub opened this issue Jun 21, 2019 · 3 comments · Fixed by #40

Comments

@ytmhub
Copy link

ytmhub commented Jun 21, 2019

Since the latest merge, it seems the compiler panics when generating docs.
I know this is probably a rustc error (as proclaimed by the compiler as well) and has nothing to do with the changes made, but I'm not familiar enough with it to properly report it in the rustc repo.

Anyway, this is what I'm getting after running cargo doc:


thread 'rustc' panicked at 'Box<Any>', src/librustc_errors/lib.rs:638:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace.
error: aborting due to previous error


note: the compiler unexpectedly panicked. this is a bug.

note: we would appreciate a bug report: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#bug-reports

note: rustc 1.37.0-nightly (991c719a1 2019-06-08) running on x86_64-unknown-linux-gnu

error: Could not document `xrl`.

Caused by:
  process didn't exit successfully: `rustdoc --edition=2018 --crate-name xrl src/lib.rs --color always -o /home/ytm/gits/xrl/target/doc -L dependency=/home/ytm/gits/xrl/target/debug/deps --extern bytes=/home/ytm/gits/xrl/target/debug/deps/libbytes-f3979da2585e2f8c.rmeta --extern futures=/home/ytm/gits/xrl/target/debug/deps/libfutures-4d35d0dfb2cf9c5c.rmeta --extern log=/home/ytm/gits/xrl/target/debug/deps/liblog-57adf34c664418a7.rmeta --extern serde=/home/ytm/gits/xrl/target/debug/deps/libserde-c032e6fc1443ab71.rmeta --extern serde_derive=/home/ytm/gits/xrl/target/debug/deps/libserde_derive-ea462f6a94497eaa.so --extern serde_json=/home/ytm/gits/xrl/target/debug/deps/libserde_json-174790a96bed0ec1.rmeta --extern syntect=/home/ytm/gits/xrl/target/debug/deps/libsyntect-4b9923d54456b828.rmeta --extern tokio=/home/ytm/gits/xrl/target/debug/deps/libtokio-23628aae7aaab09a.rmeta --extern tokio_codec=/home/ytm/gits/xrl/target/debug/deps/libtokio_codec-c5bf1894fd967b98.rmeta --extern tokio_process=/home/ytm/gits/xrl/target/debug/deps/libtokio_process-c3dbf4897bc08d57.rmeta` (exit code: 1)
@Cogitri
Copy link
Collaborator

Cogitri commented Jun 21, 2019

As you've guessed, this is on Rust: rust-lang/rust#61732

I guess I'll keep this open as sort of a tracking issue.

Thanks for reporting!

@Skepfyr
Copy link

Skepfyr commented Jun 26, 2019

I'm reasonably sure it's caused by this line:

pub(in crate::r#mod) fn new(

I don't think that's valid rust, but truthfully I have no idea as I can't find that construction documented anywhere, and it does compile...

@Cogitri
Copy link
Collaborator

Cogitri commented Jul 21, 2019

I don't think that's valid rust, but truthfully I have no idea as I can't find that construction documented anywhere

https://doc.rust-lang.org/reference/visibility-and-privacy.html suggests it should be fine, but removing it does indeed fix the thing. I don't actually think we need that line anymore, or do we, @little-dude ?

Cogitri added a commit to Cogitri/xrl that referenced this issue Jul 21, 2019
We don't actually need this function to be public and it crashes rustc when
compiling docs

fixes xi-frontend#36
Cogitri added a commit to Cogitri/xrl that referenced this issue Jul 21, 2019
We don't actually need this function to be public and it crashes rustc when
compiling docs

fixes xi-frontend#36
Cogitri added a commit that referenced this issue Jul 23, 2019
We don't actually need this function to be public and it crashes rustc when
compiling docs

fixes #36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants