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.

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

Rustdoc Builds Take 20-40 minutes. #4905

Closed
cwfitzgerald opened this issue Dec 20, 2023 · 5 comments · Fixed by #6100
Closed

Rustdoc Builds Take 20-40 minutes. #4905

cwfitzgerald opened this issue Dec 20, 2023 · 5 comments · Fixed by #6100
Labels
area: infrastructure Testing, building, coordinating issues external: upstream Issues happening in lower level APIs or platforms

Comments

@cwfitzgerald
Copy link
Member

For some reason, starting at #4880, all rustdoc builds started taking forever. This reproduces locally, though is fixed on nightly. Going to force rustdoc to nightly in the mean time.
@cwfitzgerald cwfitzgerald mentioned this issue Dec 20, 2023
Merged
@cwfitzgerald cwfitzgerald mentioned this issue Jan 6, 2024
Merged
@cwfitzgerald cwfitzgerald added external: upstream Issues happening in lower level APIs or platforms area: infrastructure Testing, building, coordinating issues labels Jan 10, 2024
@cwfitzgerald
Copy link
Member Author

cwfitzgerald commented Jan 10, 2024 •
edited
Loading

This is fixed in rustc 1.76 (beta as of writing)

@cwfitzgerald cwfitzgerald mentioned this issue Jan 17, 2024
Open
@Imberflur
Copy link
Contributor

For me the time jumps up from ~36 seconds before 192a2fe to ~450 seconds after which roughly matches the multiplier of going from 1 to 12 (36 * 12 = 432) FastHashMap fields (each with unique type parameters) in ResourceMaps.

@Imberflur
Copy link
Contributor

On nightly the effect of 192a2fe seems to be resolved as mentioned above. However, cargo doc -p wgpu-core --no-deps times go from 10-15 seconds to 80 seconds on efb35d4. Not quite as extreme, but still somewhat of a significant increase.

Nightly version tested is 1.77.0-nightly (5bd5d214e 2024-01-25)

@yanchith
Copy link
Contributor

Sorry to ping here, but I think the issue is back. Recently updated both the toolchain and wgpu. On nightly-2024-05-13, building docs for wgpu 0.20.0 takes about 13 minutes on very powerful computer.

@cwfitzgerald
Copy link
Member Author

No worries, there's not a ton we can do here, this is on the rustdoc team - someone assigned themselves to the upstream issue last week, so hopefully we'll see progress soon.

This was referenced Jun 11, 2024
Merged
Merged
kpreid added a commit to kpreid/wgpu that referenced this issue Jul 18, 2024
@kpreid
Disable wgpu-core documentation as a workaround for gfx-rs#4905.
a75aef0 
This enables `cargo doc` to succeed in a reasonable amount of time,
as long as the reader isn't looking for documentation for `wgpu-core`
itself.
@kpreid kpreid mentioned this issue Jul 18, 2024
Merged
6 tasks
kpreid added a commit to kpreid/wgpu that referenced this issue Jul 18, 2024
@kpreid
Disable wgpu-core documentation as a workaround for gfx-rs#4905.
f4858e1 
This enables `cargo doc` to succeed in a reasonable amount of time,
as long as the reader isn't looking for documentation for `wgpu-core`
itself.
kpreid added a commit to kpreid/wgpu that referenced this issue Jul 18, 2024
@kpreid
Disable wgpu-core documentation as a workaround for gfx-rs#4905.
61e28ce 
This enables `cargo doc` to succeed in a reasonable amount of time,
as long as the reader isn't looking for documentation for `wgpu-core`
itself.
kpreid added a commit to kpreid/wgpu that referenced this issue Jul 18, 2024
@kpreid
Disable wgpu-core documentation as a workaround for gfx-rs#4905.
905f7e4 
This enables `cargo doc` to succeed in a reasonable amount of time,
as long as the reader isn't looking for documentation for `wgpu-core`
itself.
kpreid added a commit to kpreid/wgpu that referenced this issue Jul 19, 2024
@kpreid
Disable wgpu-core documentation as a workaround for gfx-rs#4905.
bd2d8cd 
This enables `cargo doc` to succeed in a reasonable amount of time,
as long as the reader isn't looking for documentation for `wgpu-core`
itself.
@Wumpf Wumpf mentioned this issue Jul 19, 2024
Closed
kpreid added a commit to kpreid/wgpu that referenced this issue Jul 19, 2024
@kpreid
Disable wgpu-core documentation as a workaround for gfx-rs#4905.
c7ac1c3 
This enables `cargo doc` to succeed in a reasonable amount of time,
as long as the reader isn't looking for documentation for `wgpu-core`
itself.
cwfitzgerald pushed a commit that referenced this issue Jul 19, 2024
@kpreid @cwfitzgerald
Disable wgpu-core documentation as a workaround for #4905.
b5934e8 
This enables `cargo doc` to succeed in a reasonable amount of time,
as long as the reader isn't looking for documentation for `wgpu-core`
itself.
cwfitzgerald pushed a commit to cwfitzgerald/wgpu that referenced this issue Jul 31, 2024
@kpreid @cwfitzgerald
Disable wgpu-core documentation as a workaround for gfx-rs#4905 (gfx-…
f5003d4 
…rs#5987)

This enables `cargo doc` to succeed in a reasonable amount of time,
as long as the reader isn't looking for documentation for `wgpu-core`
itself.

(cherry picked from commit b5934e8)

# Conflicts:
#	CHANGELOG.md
@Wumpf Wumpf mentioned this issue Aug 10, 2024
Merged
6 tasks
@jimblandy jimblandy mentioned this issue Aug 21, 2024
Closed
jimblandy added a commit to jimblandy/wgpu that referenced this issue Aug 21, 2024
@jimblandy
Use the repo's MSRV for building docs.
146610b 
Remove `DOCS_RUST_VERSION`, which is no longer needed now that gfx-rs#4905
is fixed, and just go with the Rust version installed by the prior
commands.

Fixes gfx-rs#6139.
This was referenced Aug 21, 2024
Merged
Closed
jimblandy added a commit to jimblandy/wgpu that referenced this issue Sep 5, 2024
@jimblandy
[ci] Re-enable cargo doc --document-private-items in CI
3ed5753 
Re-enable CI checks that naga, wgpu-core, and wgpu-hal documentation
builds without warnings, even with `--document-private-items`. This
was previously disabled due to gfx-rs#4905, which causes long build times,
but with the de-generification of `wgpu_core`, that's no longer a
problem: a build of all three crates' docs now takes only 7s.
@jimblandy jimblandy mentioned this issue Sep 5, 2024
Merged
ErichDonGubler added a commit that referenced this issue Sep 5, 2024
@jimblandy @ErichDonGubler
[ci] Re-enable cargo doc --document-private-items in CI (#6224)
0b93030 
[ci] Re-enable `cargo doc --document-private-items` in CI

Re-enable CI checks that naga, wgpu-core, and wgpu-hal documentation
builds without warnings, even with `--document-private-items`. This
was previously disabled due to #4905, which causes long build times,
but with the de-generification of `wgpu_core`, that's no longer a
problem: a build of all three crates' docs now takes only 7s.

---------

Co-authored-by: Erich Gubler <erichdongubler@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: infrastructure Testing, building, coordinating issues external: upstream Issues happening in lower level APIs or platforms
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Degenerification part 3/3: remove gfx_select, remove compute/render pass indirections Wumpf/wgpu
3 participants
@yanchith @Imberflur @cwfitzgerald