Permalink
Browse files

updated README with FAQ section

  • Loading branch information...
1 parent c6f9aba commit c9981b7e08838c284f6b6bef8e730476c9d7fed8 Mirco committed May 26, 2011
Showing with 7 additions and 1 deletion.
  1. +6 −0 README.md
  2. +1 −1 core/src/main/scala/ssol/tools/mima/lib/MiMaLib.scala
View
@@ -21,6 +21,7 @@ Launch MiMa
$ xsbt run
+
Functional Tests
-------
@@ -48,6 +49,11 @@ Tests within the `functional-tests` folder should always pass. If you spot a bug
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 should increase the VM arguments for the initial heap size and the maximum heap size. The default values are the `-Xms64m` for for the initial heap size and `-Xmx256m` for the maximum heap size.
+
Bugs and Feature requests
-------
@@ -60,7 +60,7 @@ class MiMaLib(val log: Logging = ConsoleLogging) {
}
private def traversePackages(oldpkg: PackageInfo, newpkg: PackageInfo) {
- log.info("Traversing package " + oldpkg.fullName)
+ log.info("Traversing package " + oldpkg.fullName)
comparePackages(oldpkg, newpkg)
indented {
for (p <- oldpkg.packages.valuesIterator) {

0 comments on commit c9981b7

Please sign in to comment.