Skip to content

using symlinks in rustdoc-js tests static.files to bypass minification causes writes through symlinks, minifying orignal files #135345

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.

Sign up for GitHub

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

Jump to bottom
Closed
lolbinarycat opened this issue Jan 10, 2025 · 0 comments · Fixed by #135353
Closed

using symlinks in rustdoc-js tests static.files to bypass minification causes writes through symlinks, minifying orignal files #135345

lolbinarycat opened this issue Jan 10, 2025 · 0 comments · Fixed by #135353
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc C-bug Category: This is a bug. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Comments

@lolbinarycat
Copy link
Contributor

with the removal of --disable-minification, i was under the impression that the reccommended workflow is to symlink files in the static.files directory to their origin locations.

this workaround works completly fine when used on regular docs, however, it causes serious problems when trying to use it for the static.files in the rustdoc-js dirs.

reproduction steps:

  1. rm -r build/host/test/rustdoc-js
  2. ./x test --stage 1 tests/rustdoc-js/type-parameters.rs (any unit test should work)
  3. ln -f src/librustdoc/html/static/js/search.js build/host/test/rustdoc-js/type-parameters/static.files/search-*.js
  4. ./x test --stage 1 tests/rustdoc-js/type-parameters.rs (again)

this will result in src/librustdoc/html/static/js/search.js becoming minified.

personally i think we should just bring back the --disable-minification option as perma-unstable. that or we should have a canonical implementation of this symlink hack integrated into bootstrap.
@lolbinarycat lolbinarycat added C-bug Category: This is a bug. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Jan 10, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jan 10, 2025
lolbinarycat added a commit to lolbinarycat/rust that referenced this issue Jan 10, 2025
@lolbinarycat
re-add --disable-minification to rustdoc
d62a16f 
this also makes the rust.docs-minification option work
as advertised in config.toml

nothing fancy this time, this is intended to be perma-unstable.
it's only really here for the benefit of rustdoc devs.

mitegates rust-lang#135345
This was referenced Jan 11, 2025
Merged
Merged
lolbinarycat added a commit to lolbinarycat/rust that referenced this issue Jan 11, 2025
@lolbinarycat
re-add --disable-minification to rustdoc
706fa7c 
this also makes the rust.docs-minification option work
as advertised in config.toml

nothing fancy this time, this is intended to be perma-unstable.
it's only really here for the benefit of rustdoc devs.

mitegates rust-lang#135345
lolbinarycat added a commit to lolbinarycat/rust that referenced this issue Jan 11, 2025
@lolbinarycat
re-add --disable-minification to rustdoc
e0463df 
this also makes the rust.docs-minification option work
as advertised in config.toml

nothing fancy this time, this is intended to be perma-unstable.
it's only really here for the benefit of rustdoc devs.

mitegates rust-lang#135345
@jieyouxu jieyouxu added A-testsuite Area: The testsuite used to check the correctness of rustc and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Jan 11, 2025
lolbinarycat added a commit to lolbinarycat/rust that referenced this issue Jan 11, 2025
@lolbinarycat
re-add --disable-minification to rustdoc
d4057e8 
this also makes the rust.docs-minification option work
as advertised in config.toml

nothing fancy this time, this is intended to be perma-unstable.
it's only really here for the benefit of rustdoc devs.

mitegates rust-lang#135345
@fmease fmease linked a pull request Jan 11, 2025 that will close this issue
re-add --disable-minification to rustdoc #135353
Merged
workingjubilee added a commit to workingjubilee/rustc that referenced this issue Jan 15, 2025
@workingjubilee
Rollup merge of rust-lang#135353 - lolbinarycat:rustdoc-disable-minif…
b998c29 
…ication, r=notriddle

re-add --disable-minification to rustdoc

this also makes the rust.docs-minification option work as advertised in config.toml

nothing fancy this time, this is intended to be perma-unstable. it's only really here for the benefit of rustdoc devs.

mitegates rust-lang#135345

It was removed in rust-lang@f9e1f6f.
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Jan 15, 2025
@rust-timer
Unrolled build for rust-lang#135353
961af9b 
Rollup merge of rust-lang#135353 - lolbinarycat:rustdoc-disable-minification, r=notriddle

re-add --disable-minification to rustdoc

this also makes the rust.docs-minification option work as advertised in config.toml

nothing fancy this time, this is intended to be perma-unstable. it's only really here for the benefit of rustdoc devs.

mitegates rust-lang#135345

It was removed in rust-lang@f9e1f6f.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc C-bug Category: This is a bug. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

re-add --disable-minification to rustdoc lolbinarycat/rust
3 participants
@lolbinarycat @jieyouxu @rustbot