New upstream version 1.69.0+dfsg1

[rustc.git] / compiler / rustc_driver_impl / README.md

diff --git a/compiler/rustc_driver_impl/README.md b/compiler/rustc_driver_impl/README.md
new file mode 100644 (file)
index 0000000..6d7fba3
--- /dev/null
+++ b/compiler/rustc_driver_impl/README.md
@@ -0,0 +1,10 @@
+The `driver` crate is effectively the "main" function for the rust
+compiler. It orchestrates the compilation process and "knits together"
+the code from the other crates within rustc. This crate itself does
+not contain any of the "main logic" of the compiler (though it does
+have some code related to pretty printing or other minor compiler
+options).
+
+For more information about how the driver works, see the [rustc dev guide].
+
+[rustc dev guide]: https://rustc-dev-guide.rust-lang.org/rustc-driver.html