summaryrefslogtreecommitdiffstats
path: root/vendor/rls-data/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/rls-data/README.md')
-rw-r--r--vendor/rls-data/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/vendor/rls-data/README.md b/vendor/rls-data/README.md
new file mode 100644
index 000000000..c9c2638dc
--- /dev/null
+++ b/vendor/rls-data/README.md
@@ -0,0 +1,11 @@
+# RLS-data
+
+Data structures used by the RLS and the Rust compiler.
+
+These are used by the save-analysis functionality in the compiler
+(`rustc -Zsave-analysis`). In that use, the compiler translates info in its
+internal data structures to these data structures then serialises them as JSON.
+Clients (such as the RLS) can use this crate when deserialising.
+
+The data can also be passed directly from compiler to client if the compiler is
+used as a library.