diff --git a/docs/docs/index.md b/docs/docs/index.md index 71d29ea337b9..3a65e20c4142 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -10,38 +10,3 @@ The theory behind these constructors is researched in DOT, a calculus for depend In this documentation you will find information on how to use the Dotty compiler on your machine, navigate through the code, setup Dotty with your favorite IDE and more! - -Contents -------- - -* Dotty Language Reference - - [Intersection Types](reference/intersection-types.md) - - [Union Types](reference/union-types.md) - - [Trait Parameters](reference/trait-parameters.md) - - [Enumerations](reference/enums.md) - - [Algebraic Data Types](reference/adts.md) - - [Enum Translation](reference/desugarEnums.md) - - [By-Name Implicits](reference/implicit-by-name-parameters.md) -* Usage - - [Migrating from Scala 2](usage/migrating.md): migration information - - [Dotty projects with sbt](usage/sbt-projects.md): using sbt - - [IDE support for Dotty](usage/ide-support.md) - - [Dotty projects with cbt](usage/cbt-projects.md): using cbt -* Contributing - - [Getting Started](contributing/getting-started.md): details on how to run tests, use the cli scripts - - [Workflow](contributing/workflow.md): common dev patterns and hints - - [Eclipse](contributing/eclipse.md): setting up dev environment - - [Intellij-IDEA](contributing/intellij-idea.md): setting up dev environment - - [Working with the Backend](contributing/backend.md): working with the scala backend -* Internals document the compiler internals - - [Syntax Summary](internals/syntax.md): brief analysis of the syntax - - [Project Structure](internals/overall-structure.md): of the project - - [Backend](internals/backend.md): details on the bytecode backend - - [Contexts](internals/contexts.md): details the use of `Context` in the compiler - - [Dotty vs Scala 2](internals/dotc-scalac.md): explaining the differences between Scalac and Dotty - - [Higher Kinded Type Scheme](internals/higher-kinded-v2.md): scheme - - [Periods](internals/periods.md): details on the concepts of runs, phases and periods - - [Type System](internals/type-system.md): details on the type system of Dotty -* Resources - - [Talks](resources/talks.md): presentations of the various aspects of Dotty - diff --git a/docs/docs/usage/cbt-projects.md b/docs/docs/usage/cbt-projects.md index 2459a29e3ed6..a40bb92a74fa 100644 --- a/docs/docs/usage/cbt-projects.md +++ b/docs/docs/usage/cbt-projects.md @@ -3,6 +3,9 @@ layout: doc-page title: "Using Dotty with cbt" --- +**NOTE: cbt support for Dotty is experimental and incomplete (for example, +incremental compilation is not supported), we recommend [using Dotty with sbt](sbt-projects.md) for now.** + cbt comes with built-in Dotty support. Follow the [cbt tutorial](https://github.com/cvogt/cbt/), then simply extend `Dotty` in the Build class. diff --git a/docs/docs/usage/migrating.md b/docs/docs/usage/migrating.md deleted file mode 100644 index 5a2f64be3d16..000000000000 --- a/docs/docs/usage/migrating.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: doc-page -title: "Migrating to Dotty" ---- - -### Minor tweaks ### - * `sym.linkedClassOfClass` => `sym.linkedClass` - * `definitions` => `ctx.definitions` - -### Member Lookup ### -`tpe.member(name)` and `tpe.decl(name)` now return a `Denotation`, not a -`Symbol`. If no definition is found they return `NoDenotation` (instead of -`NoSymbol`). - -### Symbol Properties ### -Most `sym.isProperty` methods don't exist in dotc, test for flags instead. See -[dotc vs scalac: Trees, Symbols, Types & Denotations] - -### Logging, Error Reporting, Failures ### -There are various kinds of logging: - -* Errors, warnings, etc: `ctx.inform`, `ctx.warning`, `ctx.error`, ... -* Log messages displayed under `-Ylog:phase`: `log(msg)` in scalac => - `ctx.log(msg)` in dotc -* Debug-Log messages displayed under `-Ydebug -Ylog:`: `debuglog(msg)` - in scalac => `ctx.debuglog(msg)` in dotc -* Assertions: `assert(invariant)` -* Fatal errors: `abort(msg)` in scalac => `throw new - dotty.tools.dotc.FatalError(msg)` in dotc - - -#### During development / debugging #### -Instead of `Predef.println`, use `dotc.config.Printers.somePrinter.println` -[Printers.scala]. Printers can be easily added, enabled and disabled -without changing command line arguments. - -```scala -val default: Printer = new Printer // new Printer => print -val core: Printer = noPrinter // noPrinter => shut up -``` - -[dotc vs scalac: Trees, Symbols, Types & Denotations]: https://github.com/lampepfl/dotty/wiki/dotc-vs-scalac:-Trees,-Symbols,-Types-&-Denotations -[Printers.scala]: https://github.com/lampepfl/dotty/blob/master/src/dotty/tools/dotc/config/Printers.scala