GitLab will be upgraded on June 2nd 2020 at 2.00 pm (AEDT) to 3.00 pm (AEDT) due to Critical Security Patch Availability. During the update, GitLab and Mattermost services will not be available. If you have any concerns with this, please talk to local Gitlab admin team.

Commit 77c0e18a authored by Kunshan Wang's avatar Kunshan Wang

Temporarily disable sbt-eclipse plugin.

A bug causes `sbt compile` to hang after compilation finishes
successfully.

URL: https://github.com/typesafehub/sbteclipse/issues/346
parent e6c482b3
...@@ -19,7 +19,7 @@ Specification](https://gitlab.anu.edu.au/mu/mu-spec). ...@@ -19,7 +19,7 @@ Specification](https://gitlab.anu.edu.au/mu/mu-spec).
* If you use Mac, install [Homebrew](http://brew.sh/). * If you use Mac, install [Homebrew](http://brew.sh/).
* Install [Scala](http://scala-lang.org/) 2.12. If you use Mac and Homebrew, * Install [Scala](http://scala-lang.org/) 2.12. If you use Mac and Homebrew,
`brew install scala`. `brew install scala`.
* Install [sbt](http://www.scala-sbt.org/) 0.13. If you use Mac and Homebrew, * Install [sbt](http://www.scala-sbt.org/) 1.0. If you use Mac and Homebrew,
`brew install sbt`. `brew install sbt`.
* Install [Scala IDE](http://scala-ide.org/) 4.6 or later (Eclipse with * Install [Scala IDE](http://scala-ide.org/) 4.6 or later (Eclipse with
pre-installed plugins for Scala). pre-installed plugins for Scala).
...@@ -37,12 +37,25 @@ git clone https://gitlab.anu.edu.au/mu/mu-impl-ref2.git ...@@ -37,12 +37,25 @@ git clone https://gitlab.anu.edu.au/mu/mu-impl-ref2.git
* In the directory `mu-impl-ref2`, do the following: * In the directory `mu-impl-ref2`, do the following:
```bash
sbt update genSrc
```
Then edit the project using your favourite IDE (or text editor).
* There is a [bug in the sbt-eclipse
plugin](https://github.com/typesafehub/sbteclipse/issues/346) that prevents us
form using it with SBT 1.0.0, therefore we cannot generate Eclipse project.
Other IDEs, such as IntelliJ IDEA, should not be affected.
<!--
```bash ```bash
sbt update genSrc eclipse sbt update genSrc eclipse
``` ```
* Open Scala IDE and import the generated project as "existing project into * Open Scala IDE and import the generated project as "existing project into
workspace". workspace".
-->
**Detailed guide**: **Detailed guide**:
...@@ -50,7 +63,7 @@ The reference implementation is developed and tested with Java VM 8. You need a ...@@ -50,7 +63,7 @@ The reference implementation is developed and tested with Java VM 8. You need a
JRE to build the Scala/Java part, and a JDK to build the C binding. JRE to build the Scala/Java part, and a JDK to build the C binding.
You also need [Scala](http://scala-lang.org/) 2.12 and You also need [Scala](http://scala-lang.org/) 2.12 and
[sbt](http://www.scala-sbt.org/) 0.13. It is recommended to install them using [sbt](http://www.scala-sbt.org/) 1.0. It is recommended to install them using
the package manager of your operating system or distribution (such as apt-get, the package manager of your operating system or distribution (such as apt-get,
yum, pacman, etc. for GNU/Linux distributions and Homebrew for Mac OS X) if such yum, pacman, etc. for GNU/Linux distributions and Homebrew for Mac OS X) if such
packages are available. packages are available.
...@@ -58,7 +71,7 @@ packages are available. ...@@ -58,7 +71,7 @@ packages are available.
For Ubuntu users: Ubuntu 15.10 does not provide sbt in its repository. Please For Ubuntu users: Ubuntu 15.10 does not provide sbt in its repository. Please
[download sbt](http://www.scala-sbt.org/download.html) from the official sbt web [download sbt](http://www.scala-sbt.org/download.html) from the official sbt web
site, or follow the [official sbt installing guide for site, or follow the [official sbt installing guide for
Linux](http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html). If Linux](http://www.scala-sbt.org/1.x/docs/Installing-sbt-on-Linux.html). If
you experience any "certificate" problems, [this you experience any "certificate" problems, [this
page](https://github.com/sbt/sbt/issues/2295) provides a solution. page](https://github.com/sbt/sbt/issues/2295) provides a solution.
...@@ -74,10 +87,16 @@ compile this project. Or you can do it step by step: ...@@ -74,10 +87,16 @@ compile this project. Or you can do it step by step:
* To compile, invoke `sbt compile`. This will also generate the Mu IR parser * To compile, invoke `sbt compile`. This will also generate the Mu IR parser
using Antlr. using Antlr.
As mentioned before, a bug in [sbt-eclipse
plugin](https://github.com/typesafehub/sbteclipse) prevents us from using it on
Sbt 1.0. Let's wait for it to be fixed.
<!--
To generate an Eclipse project, install the [sbt-eclipse To generate an Eclipse project, install the [sbt-eclipse
plugin](https://github.com/typesafehub/sbteclipse) and invoke `sbt eclipse`. plugin](https://github.com/typesafehub/sbteclipse) and invoke `sbt eclipse`.
Make sure you generate the parser (`sbt genSrc`) before creating the Eclipse Make sure you generate the parser (`sbt genSrc`) before creating the Eclipse
project, so that the generated sources will be on the Eclipse build path. project, so that the generated sources will be on the Eclipse build path.
-->
IntelliJ IDEA has plugins for Scala and SBT. Make sure you don't commit `.idea` IntelliJ IDEA has plugins for Scala and SBT. Make sure you don't commit `.idea`
or generated project files into the repository. or generated project files into the repository.
......
addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "5.2.1") //addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "5.2.1")
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment