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

Fix main.js for gtk-rs #59958

Closed
wants to merge 1 commit into from

Conversation

GuillaumeGomez
Copy link
Member

We need it for gtk-rs. :)

r? @rust-lang/rustdoc

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 14, 2019
@jonas-schievink
Copy link
Contributor

jonas-schievink commented Apr 14, 2019

Can you add a comment explaining what it's doing and why?

@jonas-schievink jonas-schievink added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 14, 2019
@QuietMisdreavus
Copy link
Member

What is gtk-rs doing that requires this fix?

@GuillaumeGomez
Copy link
Member Author

It's checking that the values exist before using them.

@jonas-schievink
Copy link
Contributor

Is that only needed by gtk-rs, or would all crates benefit? Why or why not?

@GuillaumeGomez
Copy link
Member Author

I assume that if we had this issue with gtk-rs, other crates might encounter it as well.

@jonas-schievink
Copy link
Contributor

What issue though? Is there an upstream issue you can link to? Why is gtk-rs hitting this and (apparently) no other crates?

@GuillaumeGomez
Copy link
Member Author

I think it's because we're generating a lot of crates at once, which is rarely done outside (or just locally).

Another difference is that we generate without crates' docs without minification and then run the minification. However, the process is the same as in rustdoc so chances that it comes from there are quite small.

@Dylan-DPC-zz
Copy link

r? @GuillaumeGomez

@Dylan-DPC-zz
Copy link

oops
r? @QuietMisdreavus

@QuietMisdreavus
Copy link
Member

I think it's because we're generating a lot of crates at once, which is rarely done outside (or just locally).

What do you mean by "a lot of crates at once"? That sounds to me like a regular cargo doc run of any crate with a deep dependency tree, or a workspace with many crates in it (like the compiler).

Another difference is that we generate without crates' docs without minification and then run the minification. However, the process is the same as in rustdoc so chances that it comes from there are quite small.

In other words, you run your crates' docs with --disable-minification except for the last one? (Or do you run some client of the minifier crate over it after all the crates have been run?) That sounds like a minifier bug more than a rustdoc bug.


To be clear, the actual change in this PR is small and not even that controversial. What i'm concerned about is that it looked like there was no investigation into what was going on, and that it was framed as a fix specifically for gtk-rs. It sets a weird precedent if one of us can shotgun our fixes through without so much as opening an issue (which you usually do for your small changes anyway, but not here) if the bug personally affects our own other projects, but anyone else with large/nonstandard project structures (e.g. rustc, Servo, Fuchsia) has to follow the usual process of opening an issue, contributing to an investigation, and waiting for a PR to open, review, and land.

@Dylan-DPC-zz
Copy link

ping from triage @QuietMisdreavus what's the status of this?

@Dylan-DPC-zz Dylan-DPC-zz added S-waiting-on-team Status: Awaiting decision from the relevant subteam (see the T-<team> label). and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 20, 2019
@QuietMisdreavus
Copy link
Member

I never heard back from @GuillaumeGomez about what gtk-rs was doing that made this change necessary. I'm convinced this is papering up a different bug in the minifier crate, or in rustdoc's handling of it, instead of something the javascript itself would otherwise have to care about.

@GuillaumeGomez
Copy link
Member Author

I wasn't able to determine if the bug was coming from rustdoc or my gtk-rs minification process... I can't use a workspace system so I'm stuck with using this fix for the moment.

@Mark-Simulacrum
Copy link
Member

I'm closing this PR as the relevant procedure should likely be followed here; see #59958 (comment). Please reopen once that investigation is conducted and the PR description is updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-team Status: Awaiting decision from the relevant subteam (see the T-<team> label). T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants