about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authormark <markm@cs.wisc.edu>2018-07-15 18:51:41 -0500
committerWho? Me?! <mark-i-m@users.noreply.github.com>2018-07-16 20:52:29 -0500
commit74ffa29ef3b861dcb22b583df3535f8eba24a6b0 (patch)
treedea69da101b20f501bb2befdb06bd71aa87c8dc1 /src/doc/rustc-dev-guide
parent890585abf05672c3b6dd84308d30e2008e0870e1 (diff)
downloadrust-74ffa29ef3b861dcb22b583df3535f8eba24a6b0.tar.gz
rust-74ffa29ef3b861dcb22b583df3535f8eba24a6b0.zip
minor improvements
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/SUMMARY.md2
-rw-r--r--src/doc/rustc-dev-guide/src/codegen.md5
2 files changed, 6 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md
index a41f78a1a87..206bf5d36f0 100644
--- a/src/doc/rustc-dev-guide/src/SUMMARY.md
+++ b/src/doc/rustc-dev-guide/src/SUMMARY.md
@@ -54,7 +54,7 @@
 - [Constant evaluation](./const-eval.md)
     - [miri const evaluator](./miri.md)
 - [Parameter Environments](./param_env.md)
-- [Generating LLVM IR](./codegen.md)
+- [Code Generation](./codegen.md)
 - [Emitting Diagnostics](./diag.md)
 
 ---
diff --git a/src/doc/rustc-dev-guide/src/codegen.md b/src/doc/rustc-dev-guide/src/codegen.md
index cb99e4d3804..6e68db6ea57 100644
--- a/src/doc/rustc-dev-guide/src/codegen.md
+++ b/src/doc/rustc-dev-guide/src/codegen.md
@@ -3,6 +3,11 @@
 Code generation or "codegen" is the part of the compiler that actually
 generates an executable binary. rustc uses LLVM for code generation.
 
+> NOTE: If you are looking for hints on how to debug code generation bugs,
+> please see [this section of the debugging chapter][debug].
+
+[debug]: compiler-debugging.html#debugging-llvm
+
 ## What is LLVM?
 
 All of the preceeding chapters of this guide have one thing in common: we never