summaryrefslogtreecommitdiffstats
path: root/vendor/polonius-engine/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/polonius-engine/README.md')
-rw-r--r--vendor/polonius-engine/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/vendor/polonius-engine/README.md b/vendor/polonius-engine/README.md
new file mode 100644
index 000000000..d88295e71
--- /dev/null
+++ b/vendor/polonius-engine/README.md
@@ -0,0 +1,6 @@
+This is a core library that models the borrow check. It implements the
+analysis [described in this blogpost][post]. This library is intended
+for use both by rustc and by the polonius crate, which is a distinct
+front-end intended for testing, profiling, etc.
+
+[post]: http://smallcultfollowing.com/babysteps/blog/2018/04/27/an-alias-based-formulation-of-the-borrow-checker/