diff options
| author | Mark Mansi <markm@cs.wisc.edu> | 2018-02-13 11:17:45 -0600 |
|---|---|---|
| committer | Who? Me?! <mark-i-m@users.noreply.github.com> | 2018-02-23 12:53:13 -0600 |
| commit | c7854cd88d89478215b8e6b9b3814454f4bc51e7 (patch) | |
| tree | 485980702a2327cb24ace9d411ed61bb294ff51e /src/doc | |
| parent | 871ca87f80d8bbead5d337b844ed25a2e4929fac (diff) | |
| download | rust-c7854cd88d89478215b8e6b9b3814454f4bc51e7.tar.gz rust-c7854cd88d89478215b8e6b9b3814454f4bc51e7.zip | |
Start a code index
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/SUMMARY.md | 1 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/code-index.md | 9 |
2 files changed, 10 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md index ea2a6cd98d4..04904bce786 100644 --- a/src/doc/rustc-dev-guide/src/SUMMARY.md +++ b/src/doc/rustc-dev-guide/src/SUMMARY.md @@ -28,3 +28,4 @@ - [Parameter Environments](./param_env.md) - [Generating LLVM IR](./trans.md) - [Glossary](./glossary.md) +- [Code Index](./code-index.md) diff --git a/src/doc/rustc-dev-guide/src/code-index.md b/src/doc/rustc-dev-guide/src/code-index.md new file mode 100644 index 00000000000..5b452ef0f11 --- /dev/null +++ b/src/doc/rustc-dev-guide/src/code-index.md @@ -0,0 +1,9 @@ +# Code Index + +rustc has a lot of important data structures. This is an attempt to give some +guidance on where to learn more about some of the key data structures of the +compiler. + +Item | Kind | Short description | Chapter | Declaration +----------------|----------|-----------------------------|--------------------|------------------- +`TyCtxt<'cx, 'tcx, 'tcx>` | type | The "typing context". This is the central data structure in the compiler. It is the context that you use to perform all manner of queries. | [The `ty` modules](ty.html) | [src/librustc/ty/context.rs](https://github.com/rust-lang/rust/blob/master/src/librustc/ty/context.rs) |