Skip to content

Commit 6f04a90

Browse files
committed
Improve Eclipse/IDEA pages
1 parent 796222c commit 6f04a90

File tree

4 files changed

+27
-25
lines changed

4 files changed

+27
-25
lines changed

docs/docs/contributing/backend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: doc-page
3-
title: Working with the backend
3+
title: Working with the Backend
44
---
55

66
The compiler backend is based on a fork of the Scala 2.11 `GenBCode` backend and

docs/docs/contributing/eclipse.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ You can setup Eclipse by using _[Scala IDE for Eclipse](http://scala-ide.org/)_
1010
your Eclipse distribution of choice and enable the Scala IDE from the Eclipse Marketplace, separately.
1111

1212
Assuming you have cloned dotty's repository from Github (and run `sbt managedSources` as described in
13-
[Getting Started](getting-started.md)) you can now proceed to set up Dotty with Eclipse.
13+
[Getting Started](getting-started.md)) you can now proceed to set up Dotty with Eclipse. In addition to the previous
14+
command you need to run `sbt eclipse` to generate the project structure for Eclipse.
1415

1516
- Note: It is recommended to change the default output folder (in `Properties > java
1617
build path > Source`) to `dotty/classes` instead of `dotty/bin` because

docs/docs/contributing/intellij-idea.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,13 @@ For example, to run a test you can write with or without flags:
3838
dotc tests/pos/Arrays.scala
3939
```
4040

41-
If you are interested in debugging the compiler you can enable the necessary agent on the JVM and this
42-
is done in two steps. For the first step you need to pass the
43-
necessary flag to the running VM. For convenience, this is already in comments on the `Build.scala` file under project.
41+
If you are interested in debugging the compiler you can enable the necessary agent on the JVM.
42+
This is done in two steps. For the first step you need to pass the
43+
necessary flag to the running VM. For convenience, this is already in comments on the `Build.scala` file under the
44+
`project` directory. The string you need to uncomment is the following:
45+
46+
> `"-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005"`
47+
4448
Uncomment the line and reload the project file with the `reload` command on sbt.
4549
Now, each time you run `dotc` the compiler listens at the designated address and waits the agent to connect.
4650
For, the second step you need to create a configuration for Debug through IDEA:

docs/docs/index.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,24 @@ Contents
1515
-------
1616

1717
* Usage
18-
- [Migrating from Scala 2](usage/migrating.md)
19-
- [Dotty projects with cbt](usage/cbt-projects.md)
20-
- [Dotty projects with sbt](usage/sbt-projects.md)
18+
- [Migrating from Scala 2](usage/migrating.md): migration information
19+
- [Dotty projects with cbt](usage/cbt-projects.md): using cbt
20+
- [Dotty projects with sbt](usage/sbt-projects.md): using sbt
2121
* Contributing
22-
- [Getting Started](contributing/getting-started.md) details on how to run
23-
tests, use the cli scripts
24-
- [Workflow](contributing/workflow.md) common dev patterns and hints
25-
- [Eclipse](contributing/eclipse.md) setting up dev environment
26-
- [Intellij-IDEA](contributing/intellij-idea.md) setting up dev environment
22+
- [Getting Started](contributing/getting-started.md): details on how to run tests, use the cli scripts
23+
- [Workflow](contributing/workflow.md): common dev patterns and hints
24+
- [Eclipse](contributing/eclipse.md): setting up dev environment
25+
- [Intellij-IDEA](contributing/intellij-idea.md): setting up dev environment
26+
- [Working with the Backend](contributing/backend.md): working with the scala backend
2727
* Internals document the compiler internals
28-
- [Syntax Summary](internals/syntax.md)
29-
- [Project Structure](internals/overall-structure.md)
30-
of the project
31-
- [Backend](internals/backend.md) details on the bytecode backend
32-
- [Contexts](internals/contexts.md) details the use of `Context` in the
33-
compiler
34-
- [Dotty vs Scala2](internals/dotc-scalac.md)
35-
- [Higher Kinded Type Scheme](internals/higher-kinded-v2.md)
36-
scheme
37-
- [Periods](internals/periods.md)
38-
- [Type System](internals/type-system.md)
28+
- [Syntax Summary](internals/syntax.md): brief analysis of the syntax
29+
- [Project Structure](internals/overall-structure.md): of the project
30+
- [Backend](internals/backend.md): details on the bytecode backend
31+
- [Contexts](internals/contexts.md): details the use of `Context` in the compiler
32+
- [Dotty vs Scala 2](internals/dotc-scalac.md): explaining the differences between Scalac and Dotty
33+
- [Higher Kinded Type Scheme](internals/higher-kinded-v2.md): scheme
34+
- [Periods](internals/periods.md): details on the concepts of runs, phases and periods
35+
- [Type System](internals/type-system.md): details on the type system of Dotty
3936
* Resources
40-
- [Talks](resources/talks.md)
37+
- [Talks](resources/talks.md): presentations of the various aspects of Dotty
4138

0 commit comments

Comments
 (0)