Fix attrs pos #60093

GuillaumeGomez · 2019-04-18T21:07:22Z

Screenshot:

r? @rust-lang/rustdoc

rust-highfive · 2019-04-18T22:37:07Z

The job x86_64-gnu-llvm-6.0 of your PR failed on Travis (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.

travis_time:end:0140d278:start=1555621702569470955,finish=1555621825043885335,duration=122474414380
$ git checkout -qf FETCH_HEAD
travis_fold:end:git.checkout

Encrypted environment variables have been removed for security reasons.
See https://docs.travis-ci.com/user/pull-requests/#pull-requests-and-security-restrictions
$ export SCCACHE_BUCKET=rust-lang-ci-sccache2
$ export SCCACHE_REGION=us-west-1
$ export GCP_CACHE_BUCKET=rust-lang-ci-cache
$ export AWS_ACCESS_KEY_ID=AKIA46X5W6CZEJZ6XT55
---
travis_time:start:test_assembly
Check compiletest suite=assembly mode=assembly (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
[01:18:14] 
[01:18:14] running 9 tests
[01:18:14] iiiiiiiii
[01:18:14] 
[01:18:14]  finished in 0.158
[01:18:14] travis_fold:end:test_assembly

---
travis_time:start:test_debuginfo
Check compiletest suite=debuginfo mode=debuginfo-both (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
[01:18:31] 
[01:18:31] running 121 tests
[01:18:58] .iiiii...i.....i..i...i..i.i.i..i.ii...i.....i..i....i..........iiii..........i...ii...i.......ii.i. 100/121
[01:19:02] i.i......iii.i.....ii
[01:19:02] 
[01:19:02]  finished in 31.465
[01:19:02] travis_fold:end:test_debuginfo

---
travis_time:start:test_rustdoc
Check compiletest suite=rustdoc mode=rustdoc (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
[01:23:01] 
[01:23:01] running 304 tests
[01:24:13] .....F......................i....................................................................... 100/304
[01:26:22] .................................................................................................... 300/304
[01:26:24] ....
[01:26:24] failures:
[01:26:24] 
[01:26:24] 
[01:26:24] ---- [rustdoc] rustdoc/attributes.rs stdout ----
[01:26:24] 
[01:26:24] error: htmldocck failed!
[01:26:24] status: exit code: 1
[01:26:24] command: "/usr/bin/python2.7" "/checkout/src/etc/htmldocck.py" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc/attributes" "/checkout/src/test/rustdoc/attributes.rs"
[01:26:24] ------------------------------------------
[01:26:24] 
[01:26:24] ------------------------------------------
[01:26:24] stderr:
[01:26:24] stderr:
[01:26:24] ------------------------------------------
[01:26:24] 11: @has check failed
[01:26:24]  `XPATH PATTERN` did not match
[01:26:24]  // @has foo/enum.Foo.html '//*[@class="docblock attributes"]' '#[repr(i64)]'
[01:26:24] 12: @has check failed
[01:26:24]  `XPATH PATTERN` did not match
[01:26:24]  // @has foo/enum.Foo.html '//*[@class="docblock attributes"]' '#[must_use]'
[01:26:24] Encountered 2 errors
[01:26:24] 
[01:26:24] ------------------------------------------
[01:26:24] 
---
[01:26:24] thread 'main' panicked at 'Some tests failed', src/tools/compiletest/src/main.rs:517:22
[01:26:24] note: Run with `RUST_BACKTRACE=1` environment variable to display a backtrace.
[01:26:24] 
[01:26:24] 
[01:26:24] command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-tools-bin/compiletest" "--compile-lib-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/lib" "--run-lib-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/lib/rustlib/x86_64-unknown-linux-gnu/lib" "--rustc-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustc" "--rustdoc-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustdoc" "--src-base" "/checkout/src/test/rustdoc" "--build-base" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc" "--stage-id" "stage2-x86_64-unknown-linux-gnu" "--mode" "rustdoc" "--target" "x86_64-unknown-linux-gnu" "--host" "x86_64-unknown-linux-gnu" "--llvm-filecheck" "/usr/lib/llvm-6.0/bin/FileCheck" "--host-rustcflags" "-Crpath -O -Zunstable-options  -Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--target-rustcflags" "-Crpath -O -Zunstable-options  -Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--docck-python" "/usr/bin/python2.7" "--lldb-python" "/usr/bin/python2.7" "--gdb" "/usr/bin/gdb" "--quiet" "--llvm-version" "6.0.0\n" "--system-llvm" "--cc" "" "--cxx" "" "--cflags" "" "--llvm-components" "" "--llvm-cxxflags" "" "--adb-path" "adb" "--adb-test-dir" "/data/tmp/work" "--android-cross-path" "" "--color" "always"
[01:26:24] 
[01:26:24] 
[01:26:24] failed to run: /checkout/obj/build/bootstrap/debug/bootstrap test
[01:26:24] Build completed unsuccessfully in 0:20:34
[01:26:24] Build completed unsuccessfully in 0:20:34
[01:26:24] make: *** [check] Error 1
[01:26:24] Makefile:48: recipe for target 'check' failed
The command "stamp sh -x -c "$RUN_SCRIPT"" exited with 2.
travis_time:start:081c847a
$ date && (curl -fs --head https://google.com | grep ^Date: | sed 's/Date: //g' || true)
Thu Apr 18 22:36:59 UTC 2019
---
travis_time:end:0df58f80:start=1555627021113141417,finish=1555627021169388909,duration=56247492
travis_fold:end:after_failure.4
travis_fold:start:after_failure.5
travis_time:start:0459ce56
$ cat ./obj/build/x86_64-unknown-linux-gnu/native/asan/build/lib/asan/clang_rt.asan-dynamic-i386.vers || true
cat: ./obj/build/x86_64-unknown-linux-gnu/native/asan/build/lib/asan/clang_rt.asan-dynamic-i386.vers: No such file or directory
travis_fold:end:after_failure.5
travis_fold:start:after_failure.6
travis_time:start:0682ab4c
$ dmesg | grep -i kill

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

Centril · 2019-04-28T12:04:27Z

r? @QuietMisdreavus

GuillaumeGomez · 2019-05-01T19:44:08Z

r? @Manishearth

GuillaumeGomez · 2019-05-10T08:36:43Z

ping

Manishearth · 2019-05-10T15:40:54Z

I don't understand what this is fixing, and I don't understand how. When filing such issues please include screenshots, and include a before/after in the PR.

Also you've added some parameters to some functions here but it's totally unclear what they do, please document them.

GuillaumeGomez · 2019-05-10T17:09:27Z

I thought the display on the issue was clear enough, my bad... The point here is to fix the alignment of the #[...] attributes on the types declaration. Those new arguments allow to add a new class for attributes generated inside the type declaration in order to prevent those alignment issues. The screenshot itself would just be a "normal" looking type declaration, which doesn't really makes sense on its own since it's supposed to look like this from the beginning.

Manishearth · 2019-05-10T17:19:21Z

There's no attribute there. I see padding, but no attribute.

A link to a broken page isn't good enough for this, because that page may not render the same for everyone, and once the bug is fixed it will be hard to know what was broken. Issues should be self-contained and make sense even after being fixed. So should pull requests, the justification for this should be in the comments.

The screenshot in a PR helps highlight what was changed by focusing on that. It's less necessary since usually it's just normal, but the screenshot in the issue is pretty important.

GuillaumeGomez · 2019-05-12T08:29:27Z

The issue has a broken link, not a screenshot?! Damn it... I'll try to change it later on. Sorry about the mess...

GuillaumeGomez · 2019-05-12T13:04:16Z

@Manishearth I added a screenshot on both the issue and the PR.

Manishearth · 2019-05-12T16:23:51Z

src/librustdoc/html/render.rs

@@ -3783,7 +3789,7 @@ const ATTRIBUTE_WHITELIST: &'static [&'static str] = &[
    "non_exhaustive"
 ];

-fn render_attributes(w: &mut dyn fmt::Write, it: &clean::Item) -> fmt::Result {
+fn render_attributes(w: &mut dyn fmt::Write, it: &clean::Item, top: bool) -> fmt::Result {


Still need comments explaining what this parameter does.

Manishearth

code looks good, please add some comments on the function and on the CSS

GuillaumeGomez · 2019-05-12T16:43:08Z

Yes sir!

GuillaumeGomez · 2019-05-14T12:29:03Z

Updated!

GuillaumeGomez · 2019-05-18T10:43:18Z

@Manishearth Is my comment good enough or do you have something else in mind?

Manishearth · 2019-05-18T16:03:26Z

@bors r+

bors · 2019-05-18T16:03:27Z

📌 Commit 180b859 has been approved by Manishearth

bors · 2019-05-18T20:49:29Z

⌛ Testing commit 180b859 with merge 963184b...

Fix attrs pos Fixes #60042. Screenshot: <img width="438" alt="Screenshot 2019-05-12 at 15 02 25" src="https://user-images.githubusercontent.com/3050060/57582606-1455ec00-74c7-11e9-9d4e-5ec4da4de7dd.png"> r? @rust-lang/rustdoc

bors · 2019-05-18T23:48:33Z

☀️ Test successful - checks-travis, status-appveyor
Approved by: Manishearth
Pushing 963184b to master...

GuillaumeGomez added 2 commits April 18, 2019 00:02

Fixes attributes position in types decl

5971266

Fix items alignment

19f1bad

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 18, 2019

jonas-schievink added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 18, 2019

Update test

f20d586

rust-highfive assigned QuietMisdreavus Apr 28, 2019

rust-highfive assigned Manishearth and unassigned QuietMisdreavus May 1, 2019

Manishearth reviewed May 12, 2019

View reviewed changes

Manishearth approved these changes May 12, 2019

View reviewed changes

GuillaumeGomez mentioned this pull request May 13, 2019

rustdoc: Extra margin in enum definition #60792

Closed

Add comment to explain what is the top parameter

180b859

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 18, 2019

bors added the merged-by-bors This PR was explicitly merged by bors. label May 18, 2019

bors merged commit 180b859 into rust-lang:master May 18, 2019

GuillaumeGomez deleted the fix-attrs-pos branch May 19, 2019 08:56

GuillaumeGomez mentioned this pull request Jun 11, 2019

Rustdoc: incorrect item indentation in trait declaration #61617

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix attrs pos #60093

Fix attrs pos #60093

GuillaumeGomez commented Apr 18, 2019 •

edited

Loading

rust-highfive commented Apr 18, 2019

Centril commented Apr 28, 2019

GuillaumeGomez commented May 1, 2019

GuillaumeGomez commented May 10, 2019

Manishearth commented May 10, 2019

GuillaumeGomez commented May 10, 2019

Manishearth commented May 10, 2019

GuillaumeGomez commented May 12, 2019 •

edited

Loading

GuillaumeGomez commented May 12, 2019

Manishearth May 12, 2019

Manishearth left a comment

GuillaumeGomez commented May 12, 2019

GuillaumeGomez commented May 14, 2019

GuillaumeGomez commented May 18, 2019

Manishearth commented May 18, 2019

bors commented May 18, 2019

bors commented May 18, 2019

bors commented May 18, 2019

Fix attrs pos #60093

Fix attrs pos #60093

Conversation

GuillaumeGomez commented Apr 18, 2019 • edited Loading

rust-highfive commented Apr 18, 2019

Centril commented Apr 28, 2019

GuillaumeGomez commented May 1, 2019

GuillaumeGomez commented May 10, 2019

Manishearth commented May 10, 2019

GuillaumeGomez commented May 10, 2019

Manishearth commented May 10, 2019

GuillaumeGomez commented May 12, 2019 • edited Loading

GuillaumeGomez commented May 12, 2019

Manishearth May 12, 2019

Choose a reason for hiding this comment

Manishearth left a comment

Choose a reason for hiding this comment

GuillaumeGomez commented May 12, 2019

GuillaumeGomez commented May 14, 2019

GuillaumeGomez commented May 18, 2019

Manishearth commented May 18, 2019

bors commented May 18, 2019

bors commented May 18, 2019

bors commented May 18, 2019

GuillaumeGomez commented Apr 18, 2019 •

edited

Loading

GuillaumeGomez commented May 12, 2019 •

edited

Loading