Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign up[beta API Doc] Broken links in `fmt` module #30477
Comments
alexcrichton
added
the
A-docs
label
Dec 19, 2015
This comment has been minimized.
This comment has been minimized.
|
This is an issue that affects beta as well, looking for the cause/a fix. |
This comment has been minimized.
This comment has been minimized.
|
This appears to be a rustdoc issue rather than a docs issue - documentation for all but two of the formatting traits have disappeared. |
sfackler
added
T-rustdoc
regression-from-stable-to-beta
and removed
A-docs
labels
Dec 20, 2015
This comment has been minimized.
This comment has been minimized.
|
If something disappeared from the docs, then it may be related to #30213 (or may be not). |
This comment has been minimized.
This comment has been minimized.
|
It seems like the formatting trait links were fixed in nightly. But the beta docs still have this issue. I will update the description. |
steveklabnik
changed the title
[Nightly API Doc] Broken links in `fmt` module
[beta API Doc] Broken links in `fmt` module
Dec 24, 2015
This comment has been minimized.
This comment has been minimized.
|
@brson @alexcrichton is this severe enough to justify a backport fix to beta? I'm not sure. |
This comment has been minimized.
This comment has been minimized.
|
This seems like a case where we'd want to backport the fix, but does anyone know exactly what that is yet? |
This comment has been minimized.
This comment has been minimized.
|
I'm ok backporting if somebody finds the fix. |
Manishearth
added a commit
to Manishearth/rust
that referenced
this issue
Dec 29, 2015
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this issue
Dec 29, 2015
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this issue
Dec 29, 2015
This comment has been minimized.
This comment has been minimized.
|
Could do a bisection to figure out what patch fixed it on nightly. |
brson
self-assigned this
Jan 7, 2016
This comment has been minimized.
This comment has been minimized.
|
I'm running a bisect now, let me know if you've already started doing that and I'll stop. Otherwise if you want I can take this off of you. |
This comment has been minimized.
This comment has been minimized.
|
Hrm, since I cannot reproduce that nightly actually fixes this issue for me locally, I have to retract my offer of fixing this. Currently looking for someone who would be able to tell me how exactly the docs on rust-lang are built and deployed :/ |
This comment has been minimized.
This comment has been minimized.
|
Ouch, this is annoying. Whether the files get built depends on configure arguments. Compiling the current nightly code with ./configure without --release-channel argument (default is dev) or using =beta means this bug is present, building it with --release-channel=nightly fixes it. Building the current beta code with --release-channel=nightly also produces the files in std, which explains why my bisect attempts led to only "bad" commits. I'm currently bisecting between stable and beta, to figure out when using --release-channel=beta stopped producing the files. |
This comment has been minimized.
This comment has been minimized.
|
Ok, I'm not getting further here. The bisect gives non-deterministic results, at least in the way I'm doing my testing. This is what I did: git checkout . && git clean -fdx && git submodule update depending on the output of find (whether the file exists or not) I'm declaring a revision to be good or bad. But following this exact procedure, I have gotten both a "good" and a "bad" result for the commits 8bc43ed and 1099af7. I wonder if the current situation with beta being broken and nightly being fixed is mere coincidence, or if my testing methodology is flawed. |
This comment has been minimized.
This comment has been minimized.
|
So it might be that this bug is not fixed on nightly and it's just non-deterministic. @shahn was doing builds with -j so I wonder if parallelism is introducing something non-deterministic. |
This comment has been minimized.
This comment has been minimized.
|
I retried without -j now. I built the beta tag with --release-channel=beta for configure and a plain 'make'. Once I had the extra docs made. I ran the same thing again, they did not get created. |
This comment has been minimized.
This comment has been minimized.
|
Another observation, if they weren't built the first time even an explicit "make doc" does not build them |
This comment has been minimized.
This comment has been minimized.
|
Seeing as this is seems to be a problem with the rustdoc binary, I tried bisecting by installing nightlies through multirust and running rustdoc on libstd manually. Each build seems deterministic by itself, but which files are omitted changes between builds (I don't understand why only It seems that everything is fine up until 2015-11-26 and then 2015-11-27 onwards is broken. So the problem is likely somewhere in the range 1805bba...1727dee. That includes #30043 though so there are quite a lot of changes. |
phil-opp commentedDec 19, 2015
The formatting trait links are broken (except for
DisplayandUpperExp): https://doc.rust-lang.org/nightly/std/fmt/#formatting-traitsUpdate: It seems like this was fixed on nighly. But the beta docs still have this issue.
And the link to
debug_structin thecore::Debugdoc seems broken, too: https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#examples (source: https://doc.rust-lang.org/nightly/src/core/fmt/mod.rs.html#359)