diff --git a/docs/docs/contributing/tools/eclipse.md b/docs/docs/contributing/tools/eclipse.md deleted file mode 100644 index 9445d9dd2948..000000000000 --- a/docs/docs/contributing/tools/eclipse.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: doc-page -title: Building Dotty with Eclipse ---- - -Setup ------------ - -You can setup Eclipse by using [Scala IDE for Eclipse](http://scala-ide.org/) to run Dotty. Alternatively you can download -your Eclipse distribution of choice and enable the Scala IDE from the Eclipse Marketplace, separately. - -1. Clone Dotty's repository from Github (and run `sbt managedSources` as described in -[Getting Started](getting-started.md)) -2. Generate the Eclipse configuration files: -```shell -$ sbt eclipse -``` - -- Note: It is recommended to change the default output folder (in `Properties > java - build path > Source`) to `dotty/classes` instead of `dotty/bin` because - `dotty/bin` is reserved for shell scripts. - -Optional: if you have `CLASSPATH` defined: - -1. Update your classpath to contain any new required external libraries to run - `./bin/dotc`, `./bin/dotr` outside of Eclipse. - -1. Open the `Run Configurations` tab, and edit the `tests` configuration so - that it contains a `CLASSPATH` variable which reflects the current - `CLASSPATH`. - - -Import to Eclipse ------------------ - -First step is to import dotty to Eclipse. This is done by selecting `File > Import` from the menu and selecting -_Existing Projects into Workplace_. - -![](../../../images/eclipse/eclipse-import.png "Import Dotty to Eclipse") - -On the next window, select the bare minimum configuration to run Dotty. You will need the compiler, library and the -interfaces. - -![](../../../images/eclipse/eclipse-select.png "Import Dotty Projects") - - -Running/Debugging ---------------------------------------------------- - -To run/debug Dotty you have to create a new configuration from `Run > Run Configurations`. First select the project on the -package explorer and then select the aforementioned option. On the `Main` tab you must have `dotty-compiler` for the -_Project_ and `dotty.tools.dotc.Main` for the _Main class_. Specify the arguments you want for the compiler on the -`Arguments` tab (e.g, flags and source files) and then proceed to the `Classpath` tab. There you must -specify three `Bootstrap Entries` which are the compiler, interfaces and the library as shown in the screenshot below. -Additionally you need to specify the scala-asm library as an external jar dependency. This can be found on your local -`~/.ivy2/cache/` directory. - -![](../../../images/eclipse/eclipse-runconfiguration.png "Import Dotty Projects") - -The compiler can be run and debugged using the same configuration. - diff --git a/docs/docs/contributing/tools/intellij-idea.md b/docs/docs/contributing/tools/intellij-idea.md deleted file mode 100644 index 56845066130d..000000000000 --- a/docs/docs/contributing/tools/intellij-idea.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: doc-page -title: Building Dotty with Intellij IDEA ---- - -Setup ------ - -You can setup IntelliJ [IDEA >= 2016.1](https://www.jetbrains.com/idea/nextversion) to run Dotty. - -Assuming you have cloned Dotty's repository from Github (and run `sbt managedSources` as described in [Getting Started](getting-started.md)), -you can now proceed with importing it to IDEA by selecting the -corresponding option from the startup menu. Navigate on the corresponding directory and select it. Next, you need -to select the model of the import and as the screenshot shows, select SBT. - -![](../../../images/idea/idea-import.png "Import Dotty in IDEA") - -Next, you select the version of the JDK that this project relies on and verify that you have selected 1.8 (assuming -its installed on your local machine). Otherwise, specify it by pressing *New*. - -![](../../../images/idea/idea-sdk.png "Select the JDK") - -Next we must select which modules we can import. IDEA version 2017.1 and earlier presents the full list of SBT modules -that are defined in Dotty. You can either select all (expect performance degradation if you select all) or -select only the `dotty` module. In order to do that, unselect all modules and select on `dotty`. IDEA, then, automatically -selects all the necessary dependencies and you press OK. - -![](../../../images/idea/idea-sbt.png "Select modules to import") - -In IDEA version 2017.2 and later, wait for the project to load. Then right click on `dotty` in the project explorer -and select `Load/Unload Modules...`. Select only `dotty`, accept when IDEA asks to add its dependencies and press OK. - -Running/Debugging -------- - -To run the compiler you can do it either as an sbt command or a shell script. Open an external terminal. -For the first option, a test can be run as follows. - -```shell -$ sbt -> dotc tests/pos/Arrays.scala -``` -For the second option, the compiler can be run using a script in the `bin` directory: - -```shell -$ ./bin/dotc tests/pos/Arrays.scala -``` - -If you are interested in debugging the compiler, you can use a remote debugging configuration. -This is done by launching dotc's JVM with the JDWP agent loaded. To that end, run -```shell -$ ./bin/dotc -debug tests/pos/Arrays.scala -``` -Then when dotc starts, it will suspend and wait for a debugger to connect on port `5005`. -Next a configuration for Debug must be created in IDEA: - -> Run > Edit Configurations > Add New Configuration > (select) Remote - -![](../../../images/idea/idea-debug.png "Create a Debug Configuration") - -Under `Search sources using module's classpath` select `dotty`. Set breakpoints as desired. -Then hit the button whose tooltip says `Debug dotty-debug` (since we used `dotty-debug` for the name of -the sample configuration above) in IDEA to connect the debugger to the JVM and begin debugging. The default data on the debug configuration matches the enabled agent on the VM so, probably, - you will not need to change anything else. - diff --git a/docs/docs/contributing/workflow.md b/docs/docs/contributing/workflow.md index a9ebd787534e..6c6af36488e3 100644 --- a/docs/docs/contributing/workflow.md +++ b/docs/docs/contributing/workflow.md @@ -3,9 +3,8 @@ layout: doc-page title: Workflow --- -Check [Getting Started](getting-started.md) for instructions on how to obtain the source code of dotty and -[Eclipse](tools/eclipse.md) or [IntelliJ-IDEA](tools/intellij-idea.md). -This document details common workflow patterns when working with Dotty before using the debugging tools. +Check [Getting Started](getting-started.md) for instructions on how to obtain the source code of dotty. +This document details common workflow patterns when working with Dotty. ## Compiling files with dotc ## diff --git a/docs/images/eclipse/eclipse-import.png b/docs/images/eclipse/eclipse-import.png deleted file mode 100644 index fd8584857984..000000000000 Binary files a/docs/images/eclipse/eclipse-import.png and /dev/null differ diff --git a/docs/images/eclipse/eclipse-runconfiguration.png b/docs/images/eclipse/eclipse-runconfiguration.png deleted file mode 100644 index 53f7b163cb8d..000000000000 Binary files a/docs/images/eclipse/eclipse-runconfiguration.png and /dev/null differ diff --git a/docs/images/eclipse/eclipse-select.png b/docs/images/eclipse/eclipse-select.png deleted file mode 100644 index 0f57123c13fd..000000000000 Binary files a/docs/images/eclipse/eclipse-select.png and /dev/null differ diff --git a/docs/images/idea/idea-debug.png b/docs/images/idea/idea-debug.png deleted file mode 100644 index 1dbde325ca44..000000000000 Binary files a/docs/images/idea/idea-debug.png and /dev/null differ diff --git a/docs/images/idea/idea-import.png b/docs/images/idea/idea-import.png deleted file mode 100644 index 50c1e7093573..000000000000 Binary files a/docs/images/idea/idea-import.png and /dev/null differ diff --git a/docs/images/idea/idea-sbt.png b/docs/images/idea/idea-sbt.png deleted file mode 100644 index 0d06e28fefae..000000000000 Binary files a/docs/images/idea/idea-sbt.png and /dev/null differ diff --git a/docs/images/idea/idea-sdk.png b/docs/images/idea/idea-sdk.png deleted file mode 100644 index 2d4cf2e36b7d..000000000000 Binary files a/docs/images/idea/idea-sdk.png and /dev/null differ diff --git a/docs/sidebar.yml b/docs/sidebar.yml index 5f5250184898..05a7bb5e49e6 100644 --- a/docs/sidebar.yml +++ b/docs/sidebar.yml @@ -185,10 +185,6 @@ sidebar: url: docs/contributing/debugging.html - title: IDEs and Tools subsection: - - title: Eclipse - url: docs/contributing/tools/eclipse.html - - title: IntelliJ IDEA - url: docs/contributing/tools/intellij-idea.html - title: Mill url: docs/contributing/tools/mill.html - title: Scalafix