Add: Added the instructions for debugging from rust-forge #113
Conversation
|
Working on the issue #11 |
src/compiler-debugging.md
Outdated
| 3: std::panicking::default_hook | ||
| 4: std::panicking::rust_panic_with_hook | ||
| 5: std::panicking::begin_panic | ||
| 6: rustc_typeck::check::cast::<impl rustc_typeck::check::FnCtxt<'a, 'gcx, \ |
There was a problem hiding this comment.
If this line is too long, then we could just remove it altogether...
There was a problem hiding this comment.
I had to reduce the line length, so kept it in a separate line. Now removed it.
src/compiler-debugging.md
Outdated
| In the default configuration, you don't have line numbers enabled, so the | ||
| backtrace looks like this: | ||
|
|
||
| ``` |
src/SUMMARY.md
Outdated
| @@ -52,6 +52,7 @@ | |||
| - [miri const evaluator](./miri.md) | |||
| - [Parameter Environments](./param_env.md) | |||
| - [Generating LLVM IR](./trans.md) | |||
| - [Debugging the Compiler](./compiler-debugging.md) | |||
There was a problem hiding this comment.
I think this should be moved after the testing chapter (ch 4)
|
|
||
| When you have an ICE (panic in the compiler), you can set | ||
| `RUST_BACKTRACE=1` to get the stack trace of the `panic!` like in | ||
| normal Rust programs. IIRC backtraces **don't work** on Mac and on MinGW, |
There was a problem hiding this comment.
@nikomatsakis Is this still true?
src/compiler-debugging.md
Outdated
| ``` | ||
| stack backtrace: | ||
| (~~~~ LINES REMOVED BY ME FOR BREVITY ~~~~) | ||
| 6: rustc_typeck::check::cast::<impl rustc_typeck::check::FnCtxt<'a, 'gcx, \ |
There was a problem hiding this comment.
removed the line and made it ```text
src/compiler-debugging.md
Outdated
| and look at the log output with a text editor. | ||
|
|
||
| So to put it together. | ||
| ``` |
There was a problem hiding this comment.
again, couple of shell commands and comments, so made it ```bash
src/compiler-debugging.md
Outdated
| ### Logging etiquette | ||
|
|
||
| Because calls to `debug!` are removed by default, in most cases, don't worry | ||
| about adding "unnecessary" calls to `debug!` and leaving them in in code |
src/compiler-debugging.md
Outdated
| These all produce `.dot` files. To view these files, install graphviz (e.g. | ||
| `apt-get install graphviz`) and then run the following commands: | ||
|
|
||
| ``` |
src/compiler-debugging.md
Outdated
| If you can get away with it (i.e. if it doesn't make your bug disappear), | ||
| passing `-C codegen-units=1` to rustc will make debugging easier. | ||
|
|
||
| If you want to play with the optimization pipeline, you can use the `opt` from |
There was a problem hiding this comment.
Perhaps rephrase this sentence as "If you want to play with the optimization pipeline, you can use the opt tool from ./build/<host-triple>/llvm/bin/ with the the LLVM IR emitted by rustc."
There was a problem hiding this comment.
Changed the first sentence and ended up with this paragraph!
If you want to play with the optimization pipeline, you can use the opt tool
from./build/<host-triple>/llvm/bin/with the the LLVM IR emitted by rustc.
Note that rustc emits different IR depending on whether-Ois enabled, even
without LLVM's optimizations, so if you want to play with the IR rustc emits,
you should:
let me know if it's fine!
src/compiler-debugging.md
Outdated
| that rustc emits different IR depending on whether `-O` is enabled, even without | ||
| LLVM's optimizations, so if you want to play with the IR rustc emits, | ||
| you should: | ||
| ``` |
mark-i-m
added
the
S-waiting-on-author
|
Hey @mark-i-m Fixed all the suggested changes and travis build is passing now! Waiting on one comment from @nikomatsakis Let me know if you have any other suggestions. Thanks! 🙂 |
|
@cg-cnu Thanks :) Let's wait a little while, and if Niko can't get around to it, we can add a note like "Note: this is copied from the forge. If anything needs updating, please open an issue or make a PR on the github repo." and merge... |
|
Thanks @mark-i-m ! I just did a PR on rust-forge to remove |
mark-i-m
added
S-waiting-on-review
|
Ok, so Niko is going on (well-earned) vacation. Could add a note at the top of the document (maybe bolded or something)? Then I think we can just go ahead and merge. |
|
Hey @mark-i-m Added note at the top of the page in bold! 🙂 |
|
Thanks! |
debugging.mdSUMMARY.mdat the end of the fileLet me know if you got any comments. Thanks 🙂