Skip to content

Commit 852dc63

Browse files
tshepangJohnTitor
andauthored
small improves (rust-lang#1371)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
1 parent 3252a2c commit 852dc63

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

src/doc/rustc-dev-guide/src/diagnostics.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -273,19 +273,20 @@ There are two main ways to find where a given error is emitted:
273273

274274
- `grep` for either a sub-part of the error message/label or error code. This
275275
usually works well and is straightforward, but there are some cases where
276-
the error emitting code is removed from the code where the error is
276+
the code emitting the error is removed from the code where the error is
277277
constructed behind a relatively deep call-stack. Even then, it is a good way
278278
to get your bearings.
279-
- Invoking `rustc` with the nightly-only flag `-Z treat-err-as-bug=1`, which
279+
- Invoking `rustc` with the nightly-only flag `-Z treat-err-as-bug=1`
280280
will treat the first error being emitted as an Internal Compiler Error, which
281-
allows you to use the environment variable `RUST_BACKTRACE=full` to get a
281+
allows you to get a
282282
stack trace at the point the error has been emitted. Change the `1` to
283-
something else if you whish to trigger on a later error. Some limitations
284-
with this approach is that some calls get elided from the stack trace because
285-
they get inlined in the compiled `rustc`, and the same problem we faced with
286-
the prior approach, where the _construction_ of the error is far away from
287-
where it is _emitted_. In some cases we buffer multiple errors in order to
288-
emit them in order.
283+
something else if you wish to trigger on a later error.
284+
285+
There are limitations with this approach:
286+
- Some calls get elided from the stack trace because they get inlined in the compiled `rustc`.
287+
- The _construction_ of the error is far away from where it is _emitted_,
288+
a problem similar to the one we faced with the `grep` approach.
289+
In some cases, we buffer multiple errors in order to emit them in order.
289290

290291
The regular development practices apply: judicious use of `debug!()` statements
291292
and use of a debugger to trigger break points in order to figure out in what

0 commit comments

Comments
 (0)