Strip code to the left and right in diagnostics for long lines #63402

estebank · 2019-08-09T06:18:58Z

Fix #62999.

rust-highfive · 2019-08-09T06:19:02Z

r? @eddyb

(rust_highfive has picked a reviewer for you, use r? to override)

src/test/ui/feature-gate/await-macro.stderr

estebank · 2019-08-09T14:17:19Z

TODO:

Rebase
Fix tests
Handle Unicode slicing correctly
Use calculated margins to aim at the span being roughly centered, but bias towards stripping more whitespace than code
Add width rustc flag so that cargo can set the current column width (running cargo will default the output to 140 chars)
Consider centering the position of the span as much as possible.

Current look on the code in the original report:

Edit: current look

Edit:

estebank · 2019-08-14T18:40:37Z

@rust-lang/wg-diagnostics @Centril @nikomatsakis you all might be interested in taking a look at this.

What it looks like in practice:

Update: now centered:

Centril · 2019-08-14T18:44:25Z

@estebank how does it look right now?

estebank · 2019-08-14T18:50:15Z

how does it look right now?

@Centril I'm not sure I follow? I have screenshots in the comments.

Right now the logic is:

if all the lines fit in current terminal width (or 140 chars if it couldn't be fetched), no difference to the current output
otherwise, if it would fit by removing some of the whitespace indentation, trim the beginning and put "..."
otherwise, if all the spans would fit in terminal width, trim from left and right until it is the same width as the terminal
otherwise, trim to the left and the right of the spans, but print in full

Centril · 2019-08-14T19:16:13Z

@estebank sounds good :)

oli-obk · 2019-08-15T07:32:43Z

Idk how I feel about this. It will make the move to annotate_snippets harder

eddyb · 2019-08-15T07:43:34Z

@oli-obk Can we add this to annotate_snippets instead, and try to speed up the move?

eddyb · 2019-08-18T11:09:44Z

Blocked on #63402 (comment) (or at least a decision regarding it, maybe this should've been nominated for compiler-team meeting?).

estebank · 2019-08-19T17:28:25Z

I would be ok with adding the feature to annotate-snippets, but I would like to land this asap as when it is needed, it is really needed, and it'll be useful to gather actual real world usage feedback, even if we never land it in stable. I want to see how people react.

Edit: furthermore, some of the changes include extra flags that cargo needs to know about, so it'd be nice to have it in place to speed up that part of the work.

oli-obk · 2019-08-20T21:29:06Z

ok, let's land this without touching annotate snippets first

oli-obk · 2019-08-30T01:18:38Z

@bors r+

bors · 2019-08-30T01:18:39Z

📌 Commit aaf4dc3 has been approved by oli-obk

oli-obk · 2019-08-30T01:18:46Z

r? @oli-obk

bors · 2019-08-30T06:49:22Z

⌛ Testing commit aaf4dc3 with merge 19a38de...

Strip code to the left and right in diagnostics for long lines Fix #62999.

bors · 2019-08-30T10:25:20Z

☀️ Test successful - checks-azure
Approved by: oli-obk
Pushing 19a38de to master...

rust-highfive · 2019-08-30T10:26:37Z

📣 Toolstate changed by #63402!

Tested on commit 19a38de.
Direct link to PR: #63402

💔 miri on windows: test-pass → test-fail (cc @oli-obk @RalfJung @eddyb, @rust-lang/infra).
💔 miri on linux: test-pass → test-fail (cc @oli-obk @RalfJung @eddyb, @rust-lang/infra).
🎉 rls on linux: test-fail → test-pass (cc @Xanewok, @rust-lang/infra).

@oli-obk

Tested on commit rust-lang/rust@19a38de. Direct link to PR: <rust-lang/rust#63402> 💔 miri on windows: test-pass → test-fail (cc @oli-obk @RalfJung @eddyb, @rust-lang/infra). 💔 miri on linux: test-pass → test-fail (cc @oli-obk @RalfJung @eddyb, @rust-lang/infra). 🎉 rls on linux: test-fail → test-pass (cc @Xanewok, @rust-lang/infra).

RalfJung · 2019-08-30T12:15:01Z

Interesting. This PR introduced an ICE in a Miri test.

2019-08-30T09:21:21.4479192Z error: failure produced the wrong error: exit code: 101
2019-08-30T09:21:21.4479270Z status: exit code: 101
2019-08-30T09:21:21.4479913Z command: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2-tools-bin/miri" "tests/compile-fail/validity/invalid_char.rs" "-L" "/tmp/compiletestkZNor4" "--target=x86_64-unknown-linux-gnu" "--error-format" "json" "-C" "prefer-dynamic" "-o" "/tmp/compiletestkZNor4/validity/invalid_char.stage-id" "--edition" "2018" "-Astable-features" "--sysroot" "/home/user/.cache/miri/HOST" "-L" "/tmp/compiletestkZNor4/validity/invalid_char.stage-id.aux" "-A" "unused"
2019-08-30T09:21:21.4480668Z stdout:
2019-08-30T09:21:21.4481022Z ------------------------------------------
2019-08-30T09:21:21.4481081Z 
2019-08-30T09:21:21.4481328Z ------------------------------------------
2019-08-30T09:21:21.4481434Z stderr:
2019-08-30T09:21:21.4481671Z ------------------------------------------
2019-08-30T09:21:21.4482018Z thread 'rustc' panicked at 'attempt to subtract with overflow', src/librustc_errors/emitter.rs:154:38
2019-08-30T09:21:21.4482129Z note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace.
2019-08-30T09:21:21.4482208Z 
2019-08-30T09:21:21.4482275Z error: internal compiler error: unexpected panic
2019-08-30T09:21:21.4482342Z 
2019-08-30T09:21:21.4482411Z note: the compiler unexpectedly panicked. this is a bug.
2019-08-30T09:21:21.4482462Z 
2019-08-30T09:21:21.4482813Z note: we would appreciate a bug report: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#bug-reports
2019-08-30T09:21:21.4482896Z 
2019-08-30T09:21:21.4483177Z note: rustc 1.39.0-dev running on x86_64-unknown-linux-gnu
2019-08-30T09:21:21.4483234Z 
2019-08-30T09:21:21.4483485Z note: compiler flags: -C prefer-dynamic
2019-08-30T09:21:21.4483538Z 
2019-08-30T09:21:21.4483574Z 
2019-08-30T09:21:21.4484155Z ------------------------------------------
2019-08-30T09:21:21.4484197Z 
2019-08-30T09:21:21.4484526Z thread '[compile-fail] compile-fail/validity/invalid_char.rs' panicked at 'explicit panic', /cargo/registry/src/github.com-1ecc6299db9ec823/compiletest_rs-0.3.22/src/runtest.rs:2632:9
2019-08-30T09:21:21.4484644Z note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace.
2019-08-30T09:21:21.4493103Z test [compile-fail] compile-fail/validity/invalid_char.rs ... FAILED

@estebank any idea why?

RalfJung · 2019-08-30T12:17:36Z

src/librustc_errors/emitter.rs

+            } else if self.span_right - self.span_left <= self.column_width {
+                // Attempt to fit the code window considering the spans and labels plus padding.
+                let padding_left = (self.column_width - (self.span_right - self.span_left)) / 5 * 2;
+                self.computed_left = self.span_left - padding_left;


Looks like this subtraction overflows when Miri emits an error.

@RalfJung is that the only test failing? What would be the correct steps for me to repro this? I have never used Miri. Otherwise, would you be up to taking this on? I'm sure it's a small change that's needed and hopefully there are enough comments to follow the somewhat convoluted logic.

It is the only test failing, yes. And I'm afraid I am leaving for vacation this weekend and probably won't have time for this before I leave. I also looked at the code while on the train today and could not figure out what all the magic constants (5, 2) were about...

What would be the correct steps for me to repro this?

Do a local rustc build with debug assertions enabled: ./x.py build src/rustc

Set up a rustup toolchain link for the stage2 directory of that build

git clone https://github.com/rust-lang/miri/, then cd into that dir

rustup override set <the linked toolchain>

RUST_BACKTRACE=1 ./miri run-debug tests/compile-fail/validity/invalid_char.rs

Fixed in #64029. Off-by-one error due to rounding.

Account for rounding errors when deciding the diagnostic boundaries Fix Miri by fixing the bug raised in rust-lang#63402 (comment). Fixes rust-lang#64020

Pkgsrc changes: * Remove patch which no longer applies (but what about RPATH?) * Adapt a few patches to changed files upstream. Upstream changes: Version 1.39.0 (2019-11-07) =========================== Language -------- - [You can now create `async` functions and blocks with `async fn`, `async move {}`, and `async {}` respectively, and you can now call `.await` on async expressions.][63209] - [You can now use certain attributes on function, closure, and function pointer parameters.][64010] These attributes include `cfg`, `cfg_attr`, `allow`, `warn`, `deny`, `forbid` as well as inert helper attributes used by procedural macro attributes applied to items. e.g. ```rust fn len( #[cfg(windows)] slice: &[u16], #[cfg(not(windows))] slice: &[u8], ) -> usize { slice.len() } ``` - [You can now take shared references to bind-by-move patterns in the `if` guards of `match` arms.][63118] e.g. ```rust fn main() { let array: Box<[u8; 4]> = Box::new([1, 2, 3, 4]); match array { nums // ---- `nums` is bound by move. if nums.iter().sum::<u8>() == 10 // ^------ `.iter()` implicitly takes a reference to `nums`. => { drop(nums); // ----------- Legal as `nums` was bound by move and so we have ownership. } _ => unreachable!(), } } ``` Compiler -------- - [Added tier 3\* support for the `i686-unknown-uefi` target.][64334] - [Added tier 3 support for the `sparc64-unknown-openbsd` target.][63595] - [rustc will now trim code snippets in diagnostics to fit in your terminal.] [63402] **Note** Cargo currently doesn't use this feature. Refer to [cargo#7315][cargo/7315] to track this feature's progress. - [You can now pass `--show-output` argument to test binaries to print the output of successful tests.][62600] \* Refer to Rust's [platform support page][forge-platform-support] for more information on Rust's tiered platform support. Libraries --------- - [`Vec::new` and `String::new` are now `const` functions.][64028] - [`LinkedList::new` is now a `const` function.][63684] - [`str::len`, `[T]::len` and `str::as_bytes` are now `const` functions.][63770] - [The `abs`, `wrapping_abs`, and `overflowing_abs` numeric functions are now `const`.][63786] Stabilized APIs --------------- - [`Pin::into_inner`] - [`Instant::checked_duration_since`] - [`Instant::saturating_duration_since`] Cargo ----- - [You can now publish git dependencies if supplied with a `version`.] [cargo/7237] - [The `--all` flag has been renamed to `--workspace`.][cargo/7241] Using `--all` is now deprecated. Misc ---- - [You can now pass `-Clinker` to rustdoc to control the linker used for compiling doctests.][63834] Compatibility Notes ------------------- - [Code that was previously accepted by the old borrow checker, but rejected by the NLL borrow checker is now a hard error in Rust 2018.][63565] This was previously a warning, and will also become a hard error in the Rust 2015 edition in the 1.40.0 release. - [`rustdoc` now requires `rustc` to be installed and in the same directory to run tests.][63827] This should improve performance when running a large amount of doctests. - [The `try!` macro will now issue a deprecation warning.][62672] It is recommended to use the `?` operator instead. - [`asinh(-0.0)` now correctly returns `-0.0`.][63698] Previously this returned `0.0`. [62600]: rust-lang/rust#62600 [62672]: rust-lang/rust#62672 [63118]: rust-lang/rust#63118 [63209]: rust-lang/rust#63209 [63402]: rust-lang/rust#63402 [63565]: rust-lang/rust#63565 [63595]: rust-lang/rust#63595 [63684]: rust-lang/rust#63684 [63698]: rust-lang/rust#63698 [63770]: rust-lang/rust#63770 [63786]: rust-lang/rust#63786 [63827]: rust-lang/rust#63827 [63834]: rust-lang/rust#63834 [63927]: rust-lang/rust#63927 [63933]: rust-lang/rust#63933 [63934]: rust-lang/rust#63934 [63938]: rust-lang/rust#63938 [63940]: rust-lang/rust#63940 [63941]: rust-lang/rust#63941 [63945]: rust-lang/rust#63945 [64010]: rust-lang/rust#64010 [64028]: rust-lang/rust#64028 [64334]: rust-lang/rust#64334 [cargo/7237]: rust-lang/cargo#7237 [cargo/7241]: rust-lang/cargo#7241 [cargo/7315]: rust-lang/cargo#7315 [`Pin::into_inner`]: https://doc.rust-lang.org/std/pin/struct.Pin.html#method.into_inner [`Instant::checked_duration_since`]: https://doc.rust-lang.org/std/time/struct.Instant.html#method.checked_duration_since [`Instant::saturating_duration_since`]: https://doc.rust-lang.org/std/time/struct.Instant.html#method.saturating_duration_since

@estebank

Add support for rustc's `-Z terminal-width`. This PR continues the work started in #7315, adding support for rustc's `-Z terminal-width` flag, which is used to trim diagnostic output to fit within the current terminal and was added in rust-lang/rust#63402 (with JSON emitter support in rust-lang/rust#73763). At the time of writing, rust-lang/rust#73763 isn't in nightly, so the test added in this PR will fail, but it should pass tomorrow (I've confirmed that it works with a local rustc build). cc @estebank

rust-highfive assigned eddyb Aug 9, 2019

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

estebank mentioned this pull request Aug 9, 2019

rustc should "ellipsis" very long lines when printing warnings #62999

Closed

This comment has been minimized.

Sign in to view

Centril reviewed Aug 9, 2019

View reviewed changes

src/test/ui/feature-gate/await-macro.stderr Outdated Show resolved Hide resolved

estebank changed the title ~~[WIP] Strip code to the left and right in diagnostics for long lines~~ Strip code to the left and right in diagnostics for long lines Aug 14, 2019

estebank force-pushed the strip-margin branch from 5873a18 to f240167 Compare August 14, 2019 18:31

This comment has been minimized.

Sign in to view

estebank force-pushed the strip-margin branch from 5354626 to 440b3f7 Compare August 14, 2019 19:49

This comment has been minimized.

Sign in to view

eddyb added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 18, 2019

Centril added I-nominated T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Aug 18, 2019

estebank added 5 commits August 21, 2019 11:52

Strip code to the left and right in diagnostics for long lines

0e668e0

clean up

266b878

Introduce term-size dependency and consider term width when trimming

f08b036

Fix tidy

45a6be5

Center trim on the span labels and handle unicode

de2e9fe

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 Aug 30, 2019

rust-highfive assigned oli-obk and unassigned eddyb Aug 30, 2019

bors added a commit that referenced this pull request Aug 30, 2019

Auto merge of #63402 - estebank:strip-margin, r=oli-obk

19a38de

Strip code to the left and right in diagnostics for long lines Fix #62999.

bors mentioned this pull request Aug 30, 2019

Add missing links on AsRef trait #63999

Merged

bors added the merged-by-bors This PR was explicitly merged by bors. label Aug 30, 2019

bors merged commit aaf4dc3 into rust-lang:master Aug 30, 2019

rust-highfive mentioned this pull request Aug 30, 2019

miri no longer builds after rust-lang/rust#63402 #64020

Closed

bors mentioned this pull request Aug 30, 2019

Use panic::set_hook to print the ICE message #60584

Merged

RalfJung reviewed Aug 30, 2019

View reviewed changes

This was referenced Aug 31, 2019

Account for rounding errors when deciding the diagnostic boundaries #64029

Merged

Pass the current shell width to rustc rust-lang/cargo#7315

Closed

joshtriplett added the relnotes Marks issues that should be documented in the release notes of the next release. label Sep 4, 2019

estebank mentioned this pull request Nov 8, 2019

1.39 error messages don't properly truncate, making autogenerated files (e.g. bindgen) spam the terminal #66229

Closed

davidtwco mentioned this pull request Jun 28, 2020

Add support for rustc's -Z terminal-width. rust-lang/cargo#8427

Merged

est31 mentioned this pull request Oct 27, 2020

Long line printing doesn't support tabs #78438

Closed

ehuss mentioned this pull request Apr 28, 2021

Tracking Issue for -Z terminal-width #84673

Closed

estebank mentioned this pull request Dec 28, 2022

Compiler diagnostics for missing methods in generated code are unreadable #65616

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Strip code to the left and right in diagnostics for long lines #63402

Strip code to the left and right in diagnostics for long lines #63402

estebank commented Aug 9, 2019

rust-highfive commented Aug 9, 2019

This comment has been minimized.

estebank commented Aug 9, 2019 •

edited

Loading

estebank commented Aug 14, 2019 •

edited

Loading

Centril commented Aug 14, 2019

estebank commented Aug 14, 2019

This comment has been minimized.

Centril commented Aug 14, 2019

oli-obk commented Aug 15, 2019

eddyb commented Aug 15, 2019 •

edited

Loading

This comment has been minimized.

eddyb commented Aug 18, 2019

estebank commented Aug 19, 2019 •

edited

Loading

oli-obk commented Aug 20, 2019

oli-obk commented Aug 30, 2019

bors commented Aug 30, 2019

oli-obk commented Aug 30, 2019

bors commented Aug 30, 2019

bors commented Aug 30, 2019

rust-highfive commented Aug 30, 2019

RalfJung commented Aug 30, 2019

RalfJung Aug 30, 2019

estebank Aug 30, 2019

RalfJung Aug 30, 2019 •

edited

Loading

estebank Aug 31, 2019

Strip code to the left and right in diagnostics for long lines #63402

Strip code to the left and right in diagnostics for long lines #63402

Conversation

estebank commented Aug 9, 2019

rust-highfive commented Aug 9, 2019

This comment has been minimized.

estebank commented Aug 9, 2019 • edited Loading

estebank commented Aug 14, 2019 • edited Loading

Centril commented Aug 14, 2019

estebank commented Aug 14, 2019

This comment has been minimized.

Centril commented Aug 14, 2019

oli-obk commented Aug 15, 2019

eddyb commented Aug 15, 2019 • edited Loading

This comment has been minimized.

eddyb commented Aug 18, 2019

estebank commented Aug 19, 2019 • edited Loading

oli-obk commented Aug 20, 2019

oli-obk commented Aug 30, 2019

bors commented Aug 30, 2019

oli-obk commented Aug 30, 2019

bors commented Aug 30, 2019

bors commented Aug 30, 2019

rust-highfive commented Aug 30, 2019

RalfJung commented Aug 30, 2019

RalfJung Aug 30, 2019

Choose a reason for hiding this comment

estebank Aug 30, 2019

Choose a reason for hiding this comment

RalfJung Aug 30, 2019 • edited Loading

Choose a reason for hiding this comment

estebank Aug 31, 2019

Choose a reason for hiding this comment

estebank commented Aug 9, 2019 •

edited

Loading

estebank commented Aug 14, 2019 •

edited

Loading

eddyb commented Aug 15, 2019 •

edited

Loading

estebank commented Aug 19, 2019 •

edited

Loading

RalfJung Aug 30, 2019 •

edited

Loading