about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorAlex Kitchens <alex.kitchens@stitchfix.com>2018-05-22 16:30:05 -0500
committerWho? Me?! <mark-i-m@users.noreply.github.com>2018-05-22 17:06:58 -0500
commitd6df2a2f92b17a367d771ff3f89592250663023f (patch)
treef55ca5100cf6a67a74b0d4b428adbc529211905d /src/doc/rustc-dev-guide
parent577f8ddba62b10f4434a0291234ca86fd1d13051 (diff)
downloadrust-d6df2a2f92b17a367d771ff3f89592250663023f.tar.gz
rust-d6df2a2f92b17a367d771ff3f89592250663023f.zip
Define a Cycle
I wasn't clear on what a Cycle was when reading through the document.
Defining it will be helpful for other readers not familiar with it as
well.
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/query.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/query.md b/src/doc/rustc-dev-guide/src/query.md
index 2c518ee55ee..d48b6e7e3da 100644
--- a/src/doc/rustc-dev-guide/src/query.md
+++ b/src/doc/rustc-dev-guide/src/query.md
@@ -47,6 +47,9 @@ let ty = tcx.type_of(some_def_id);
 
 ### Cycles between queries
 
+A cycle is when a query becomes stuck in a loop e.g. query A generates query B
+which generates query A again.
+
 Currently, cycles during query execution should always result in a
 compilation error. Typically, they arise because of illegal programs
 that contain cyclic references they shouldn't (though sometimes they