-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Fix servo crate name confliction on documentation #29878
Conversation
Hrm. I have been considering this change for a while, but I'm not sure if it's the right one. Renaming the library because of a documentation issue seems like the wrong incentive structure. Is there a way to fix the documentation without the rename. Perhaps we could move the runner/winit port documentation out of rustdoc and simply disable documentation for that crate? |
The tracking issue of this bug is cargo/#6313. I didn't follow through all conversations, but the beginning of the thread said this will be considered a hard error in the future. Adding |
An alternate approach here might be to rename the runner project, but have it produce the a binary with the name "servo." It's my understanding that the binary artifact itself will not conflict, but the documentation might. |
I tried this before. Artifacts will not conflict indeed, but doc will. Carge doc will still warn about this if there are crates with same names despite the fact that they might have different package names. |
☔ The latest upstream changes (presumably #29956) made this pull request unmergeable. Please resolve the merge conflicts. |
I think another workaround could be adding another command argument like |
I suspect that if changing the name of the crate is on the only way to fix this, it makes more sense to change the name of the crate of the binary rather than the crate of the library. |
./mach build -d
does not report any errors./mach test-tidy
does not report any errorsThe name of winit binary is conflicted with servo crate.
We can't read documentation of servo library crate at the moment.
It's actually the winit binary documentation.