about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorYoungsuk Kim <joseph942010@gmail.com>2019-11-08 11:09:45 -0500
committerYuki Okushi <huyuumi.dev@gmail.com>2019-11-09 01:09:44 +0900
commit5891e73cf14fa65349142d069c0ea15f57a52bc7 (patch)
treeacba3f67fc26a33f87635358b2dffc44d835c395 /src/doc/rustc-dev-guide
parent59adfcb500166008c6b7a1b02df45a76cb864c2b (diff)
downloadrust-5891e73cf14fa65349142d069c0ea15f57a52bc7.tar.gz
rust-5891e73cf14fa65349142d069c0ea15f57a52bc7.zip
Clarify function name and add links (#506)
* Clarify function name and add links 

rustc_interface::interface::run_compiler 
(https://doc.rust-lang.org/nightly/nightly-rustc/rustc_interface/interface/fn.run_compiler.html)
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/rustc-driver.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/src/doc/rustc-dev-guide/src/rustc-driver.md b/src/doc/rustc-dev-guide/src/rustc-driver.md
index 715e6295d4d..f2ed1bab8ef 100644
--- a/src/doc/rustc-dev-guide/src/rustc-driver.md
+++ b/src/doc/rustc-dev-guide/src/rustc-driver.md
@@ -9,17 +9,18 @@ for running code at particular times during the compilation process, allowing
 third parties to effectively use `rustc`'s internals as a library for
 analysing a crate or emulating the compiler in-process (e.g. the RLS or rustdoc).
 
-For those using `rustc` as a library, the `interface::run_compiler()` function is the main
-entrypoint to the compiler. It takes a configuration for the compiler and a closure that
-takes a [`Compiler`]. `run_compiler` creates a `Compiler` from the configuration and passes
-it to the closure. Inside the closure, you can use the `Compiler` to drive queries to compile
-a crate and get the results. This is what the `rustc_driver` does too.
+For those using `rustc` as a library, the [`rustc_interface::interface::run_compiler()`][i_rc]
+function is the main entrypoint to the compiler. It takes a configuration for the compiler
+and a closure that takes a [`Compiler`]. `run_compiler` creates a `Compiler` from the 
+configuration and passes it to the closure. Inside the closure, you can use the `Compiler`
+to drive queries to compile a crate and get the results. This is what the `rustc_driver` does too.
 
 You can see what queries are currently available through the rustdocs for [`Compiler`].
 You can see an example of how to use them by looking at the `rustc_driver` implementation,
 specifically the [`rustc_driver::run_compiler` function][rd_rc] (not to be confused with
-`interface::run_compiler`). The `rustc_driver::run_compiler` function takes a bunch of
-command-line args and some other configurations and drives the compilation to completion.
+[`rustc_interface::interface::run_compiler`][i_rc]). The `rustc_driver::run_compiler` function 
+takes a bunch of command-line args and some other configurations and
+drives the compilation to completion.
 
 `rustc_driver::run_compiler` also takes a [`Callbacks`][cb]. In the past, when
 the `rustc_driver::run_compiler` was the primary way to use the compiler as a
@@ -47,6 +48,7 @@ thread-locals, although you should rarely need to touch it.
 
 [cb]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_driver/trait.Callbacks.html
 [rd_rc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_driver/fn.run_compiler.html
+[i_rc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_interface/interface/fn.run_compiler.html
 [`rustc_interface`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_interface/index.html
 [`rustc_driver`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_driver/
 [`Compiler`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_interface/interface/struct.Compiler.html