about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorMark Mansi <markm@cs.wisc.edu>2018-05-08 12:40:43 -0500
committerWho? Me?! <mark-i-m@users.noreply.github.com>2018-05-12 15:04:25 -0500
commitaf56bb3f5e2edce5f41c7d9a77bf4a06f0019e2f (patch)
treed24b77cf55df36b939eedcedbed7c81d1967d99d /src/doc/rustc-dev-guide
parent6d9f93579156f76512595acbd6c1343c1682c17e (diff)
downloadrust-af56bb3f5e2edce5f41c7d9a77bf4a06f0019e2f.tar.gz
rust-af56bb3f5e2edce5f41c7d9a77bf4a06f0019e2f.zip
reword HIR intro. Fix #116
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/hir.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/src/doc/rustc-dev-guide/src/hir.md b/src/doc/rustc-dev-guide/src/hir.md
index 3d2fbede3c4..51296e55e52 100644
--- a/src/doc/rustc-dev-guide/src/hir.md
+++ b/src/doc/rustc-dev-guide/src/hir.md
@@ -1,11 +1,12 @@
 # The HIR
 
-The HIR – "High-level IR" – is the primary IR used in most of rustc.
-It is a desugared version of the "abstract syntax tree" (AST) that is generated
-after parsing, macro expansion, and name resolution have completed. Many parts
-of HIR resemble Rust surface syntax quite closely, with the exception that some
-of Rust's expression forms have been desugared away (as an example, `for` loops
-are converted into a `loop` and do not appear in the HIR).
+The HIR – "High-level IR" – is the primary IR used in most of rustc. It is a
+compiler-friendly representation of the abstract syntax tree (AST) that is
+generated after parsing, macro expansion, and name resolution have completed.
+Many parts of HIR resemble Rust surface syntax quite closely, with the
+exception that some of Rust's expression forms have been desugared away. For
+example, `for` loops are converted into a `loop` and do not appear in the HIR.
+This makes HIR more amenable to analysis than a normal AST.
 
 This chapter covers the main concepts of the HIR.