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

Keyword doc of self and Self points to the same file on windows. #80504

Closed
crlf0710 opened this issue Dec 30, 2020 · 2 comments · Fixed by #83678
Closed

Keyword doc of self and Self points to the same file on windows. #80504

crlf0710 opened this issue Dec 30, 2020 · 2 comments · Fixed by #83678
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. O-windows Operating system: Windows T-libs-api Relevant to the library API 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

@crlf0710
Copy link
Member

crlf0710 commented Dec 30, 2020

Since windows filesystem is case insensitive, when installing rust-docs on windows, the self and Self pages conflicts, leaving only one of them accessible.

This is a specific case of #25879, but since it's in rust standard library. I think it deserves its own issue (and priority).

@crlf0710 crlf0710 added O-windows Operating system: Windows T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. labels Dec 30, 2020
@GuillaumeGomez
Copy link
Member

There was a first attempt to fix this issue here, but not sure if this is the right approach.

@rbtcollins
Copy link
Contributor

For completeness - they point to the same file on MacOS X as well.

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Mar 30, 2021
…nflict, r=jyn514

Fix Self keyword doc URL conflict on case insensitive file systems (until definitely fixed on rustdoc)

This is just a hack to allow rustup to work on macOS and windows again to distribute std documentation (hopefully once rust-lang/rfcs#3097 or an equivalent is merged).

Fixes rust-lang#80504. Prevents rust-lang#83154 and rust-lang/rustup#2694 in future releases.

cc `@kinnison`
r? `@jyn514`
@bors bors closed this as completed in d51fc97 Mar 31, 2021
ehuss pushed a commit to ehuss/rust that referenced this issue Apr 21, 2021
…nflict, r=jyn514

Fix Self keyword doc URL conflict on case insensitive file systems (until definitely fixed on rustdoc)

This is just a hack to allow rustup to work on macOS and windows again to distribute std documentation (hopefully once rust-lang/rfcs#3097 or an equivalent is merged).

Fixes rust-lang#80504. Prevents rust-lang#83154 and rust-lang/rustup#2694 in future releases.

cc ``@kinnison``
r? ``@jyn514``
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. O-windows Operating system: Windows T-libs-api Relevant to the library API 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
3 participants