Skip to content
Browse files

Updated README with sbteclipse information.

  • Loading branch information...
1 parent 147173f commit 250f358c3b293bf3dcad5247bd4eeaef6db4e6a3 @dotta dotta committed Jun 5, 2011
Showing with 9 additions and 7 deletions.
  1. +9 −7 README.md
View
16 README.md
@@ -11,17 +11,19 @@ MiMa's Modules
MiMa is split into three modules:
- Core: Classes that are used by both the Reporter and Migrator modules.
-- Reporter: Used to diagnose binary incompatibilities between two different versions of a same library. (This was formerly named MiMa Lib)
-- Migrator: Used to fix binary incompatibilities of a client jar. (This was formerly named MiMa Client)
+- Reporter: Used to diagnose binary incompatibilities between two different versions of a same library. (formerly MiMa Lib)
+- Migrator: Used to fix binary incompatibilities of a client jar. (formerly MiMa Client)
Eclipse
-------
-Folders `core`, `reporter` and `migrator` contain all metadata files used by Eclipse. To set up the three modules in Eclipse just click on `File > Import > General > Exisiting Projects Into Workspace`, and select the MiMa project's root folder, the three modules should be correctly loaded.
+In order to create Eclipse metadata files (i.e., .classpath and .project) we recomend to use [sbteclipse][sbteclipse]. Once done, to set up the three modules in Eclipse just click on `File > Import > General > Exisiting Projects Into Workspace`, and select the MiMa project's root folder, the three modules should be correctly loaded.
In the `reporter` and `migrator` folders you can also find a `*.launch` file configuration, which can be imported in Eclipse and can be used to start the programs.
+[sbteclipse]: https://github.com/typesafehub/sbteclipse/
+
Build
-------
@@ -30,9 +32,9 @@ Using [the xsbt tool][xsbt].
$ xsbt clean update compile
-Make sure to use tag 0.9.8, installation notes can be found [here][xsbt].
+Make sure to use tag 0.10.0, installation notes can be found [here][xsbt].
-[xsbt]: https://github.com/harrah/xsbt/tree/0.9
+[xsbt]: https://github.com/harrah/xsbt/tree/v0.10.0
This will recompile all MiMa's modules.
@@ -75,14 +77,14 @@ To add a new functional test to the suite, create a new folder within 'functiona
After doing that, `reload` if you are in a `xsbt` console session (if that makes nosense to you, it means you are fine and you can run the test as usual).
-Tests within the `functional-tests` folder should always pass. If you spot a bug (or missing feature), please create a test that exercise the problem and put it in the `functional-tests-exposing-bugs` directory, located in the project root. Once the test succeed, then you should move it into the `functional-tests` directory.
+Tests within the `functional-tests` folder should always pass.
Note: The `problems.txt` is the test oracle. Expected errors are declared using the Mima's reporting output (i.e., the output of the tool and the expected errors should match perfectly). Admittedly, this coupling is an issue since the testing framework is highly coupled with the tool output used to report errors to the user. We should improve this and make the two independent. Until then, mind that by changing the output of the tool you will likely have to update some of the test oracles (i.e., problems.txt file).
FAQ
-------
-Exception - java.lang.OutOfMemoryError: Java heap space: If you are experiencing out of memory exception you may need to increase the VM arguments for the initial heap size and the maximum heap size. The default values are `-Xms64m` for for the initial heap size and `-Xmx256m` for the maximum heap size.
+`Exception - java.lang.OutOfMemoryError`: Java heap space: If you are experiencing out of memory exception you may need to increase the VM arguments for the initial heap size and the maximum heap size. The default values are `-Xms64m` for for the initial heap size and `-Xmx256m` for the maximum heap size.
Bugs and Feature requests
-------

0 comments on commit 250f358

Please sign in to comment.
Something went wrong with that request. Please try again.