diff options
| author | Martin Odersky <odersky@gmail.com> | 2016-03-15 11:34:21 +0100 |
|---|---|---|
| committer | Martin Odersky <odersky@gmail.com> | 2016-04-01 11:20:18 +0200 |
| commit | 1c48c1f8a0ff8f94652a98992d13fa47207a79d4 (patch) | |
| tree | 48dabceb76ac36b97bef2d1bc768da77f3ebab54 /docs | |
| parent | 5ab9e4d025b14760cdeacb7aafd44d920729f538 (diff) | |
| download | dotty-1c48c1f8a0ff8f94652a98992d13fa47207a79d4.tar.gz dotty-1c48c1f8a0ff8f94652a98992d13fa47207a79d4.tar.bz2 dotty-1c48c1f8a0ff8f94652a98992d13fa47207a79d4.zip | |
Add links
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dotc-internals/overall-structure.md | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/dotc-internals/overall-structure.md b/docs/dotc-internals/overall-structure.md index d5828ea13..93c97090f 100644 --- a/docs/dotc-internals/overall-structure.md +++ b/docs/dotc-internals/overall-structure.md @@ -1,16 +1,22 @@ # Dotc's Overall Structure -The compiler code is found in package `dotty.tools`. It spans the +The compiler code is found in package [dotty.tools](https://github.com/lampepfl/dotty/tree/master/src/dotty/tools). It spans the following three sub-packages: backend Compiler backends (currently for JVM and JS) dotc The main compiler io Helper modules for file access and classpath handling. -The `dotc` package contains some main classes that can be run as separate -programs. The most important one is class `Main`. `Main` inherits from `Driver` which -contains the highest level functions for starting a compiler and processing some sources -`Driver` in turn is based on two other high-level classes, `Compiler` and `Run`. +The [dotc](https://github.com/lampepfl/dotty/tree/master/src/dotty/tools/dotc) +package contains some main classes that can be run as separate +programs. The most important one is class +[Main](https://github.com/lampepfl/dotty/blob/master/src/dotty/tools/dotc/Main.scala). +`Main` inherits from +[Driver](https://github.com/lampepfl/dotty/blob/master/src/dotty/tools/dotc/Driver.scala) which +contains the highest level functions for starting a compiler and processing some sources. +`Driver` in turn is based on two other high-level classes, +[Compiler](https://github.com/lampepfl/dotty/blob/master/src/dotty/tools/dotc/Compiler.scala) and +[Run](https://github.com/lampepfl/dotty/blob/master/src/dotty/tools/dotc/Run.scala). ## Package Structure @@ -38,7 +44,9 @@ and their focus. `dotc` has almost no global state (the only significant bit of global state is the name table, which is used to hash strings into unique names). Instead, all essential bits of information that -can vary over a compiler run are collected in a [Context](https://github.com/lampepfl/dotty/blob/master/src/dotty/tools/dotc/core/Context.scala). Most methods in `dotc` take a Context value as an implicit parameter. +can vary over a compiler run are collected in a +[Context](https://github.com/lampepfl/dotty/blob/master/src/dotty/tools/dotc/core/Contexts.scala). +Most methods in `dotc` take a Context value as an implicit parameter. Contexts give a convenient way to customize values in some part of the call-graph. To run, e.g. some compiler function `f` at a given |