Repository: incubator-reef
Updated Branches:
  refs/heads/master c7ba94c32 -> 89435324f


[REEF-528] Add missing Javadoc comments/triage TODO notes in reef-runtime-local

JIRA:
  [REEF-528](https://issues.apache.org/jira/browse/REEF-528)

Pull request:
  This closes #530


Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/89435324
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/89435324
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/89435324

Branch: refs/heads/master
Commit: 89435324fa3d19c7a8f57b1e45e40c0ded683100
Parents: c7ba94c
Author: Mariia Mykhailova <[email protected]>
Authored: Tue Sep 29 15:17:14 2015 -0700
Committer: Markus Weimer <[email protected]>
Committed: Tue Sep 29 16:37:51 2015 -0700

----------------------------------------------------------------------
 lang/java/reef-runtime-local/pom.xml                     | 11 +++++++++++
 .../reef/runtime/local/driver/ContainerManager.java      |  6 +++---
 .../java/org/apache/reef/runtime/local/package-info.java |  2 +-
 .../runtime/local/driver/ResourceRequestQueueTest.java   |  3 +++
 .../reef/runtime/local/driver/ResourceRequestTest.java   |  3 +++
 .../apache/reef/runtime/local/driver/package-info.java   |  2 +-
 6 files changed, 22 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/89435324/lang/java/reef-runtime-local/pom.xml
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-local/pom.xml 
b/lang/java/reef-runtime-local/pom.xml
index 30dede5..1a631c1 100644
--- a/lang/java/reef-runtime-local/pom.xml
+++ b/lang/java/reef-runtime-local/pom.xml
@@ -62,6 +62,17 @@ under the License.
                 </excludes>
             </resource>
         </resources>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-checkstyle-plugin</artifactId>
+                    <configuration>
+                        
<configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation>
+                    </configuration>
+                </plugin>
+            </plugins>
+        </pluginManagement>
     </build>
 
 </project>

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/89435324/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java
 
b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java
index 96978da..552a80e 100644
--- 
a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java
+++ 
b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java
@@ -212,7 +212,7 @@ final class ContainerManager implements AutoCloseable {
             .setRackName(rackName)
             .setHostName(this.localAddress)
             .setPort(j)
-            .setMemorySize(this.defaultMemorySize) // TODO Find the actual 
system memory on this machine.
+            .setMemorySize(this.defaultMemorySize) // TODO[JIRA REEF-792] Find 
the actual system memory on this machine.
             .build());
         j++;
       }
@@ -229,8 +229,8 @@ final class ContainerManager implements AutoCloseable {
    * Returns the node name of the container to be allocated if it's available, 
selected from the list of preferred
    * node names. If the list is empty, then an empty optional is returned
    *
-   * @param rackNames
-   *          the list of preferred racks
+   * @param nodeNames
+   *          the list of preferred nodes
    * @return the node name where to allocate the container
    */
   private Optional<String> getPreferredNode(final List<String> nodeNames) {

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/89435324/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/package-info.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/package-info.java
 
b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/package-info.java
index dfd8b53..d4c84d0 100644
--- 
a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/package-info.java
+++ 
b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/package-info.java
@@ -17,6 +17,6 @@
  * under the License.
  */
 /**
- * TODO: Document.
+ * A local implementation of REEF that uses local JVMs for execution.
  */
 package org.apache.reef.runtime.local;

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/89435324/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestQueueTest.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestQueueTest.java
 
b/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestQueueTest.java
index a4271f1..44f6295 100644
--- 
a/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestQueueTest.java
+++ 
b/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestQueueTest.java
@@ -22,6 +22,9 @@ import 
org.apache.reef.runtime.common.driver.api.ResourceRequestEventImpl;
 import org.junit.Assert;
 import org.junit.Test;
 
+/**
+ * Test for ResourceRequestQueue.
+ */
 public class ResourceRequestQueueTest {
 
   @Test

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/89435324/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestTest.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestTest.java
 
b/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestTest.java
index bb1fa5b..557eb86 100644
--- 
a/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestTest.java
+++ 
b/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/ResourceRequestTest.java
@@ -22,6 +22,9 @@ import 
org.apache.reef.runtime.common.driver.api.ResourceRequestEventImpl;
 import org.junit.Assert;
 import org.junit.Test;
 
+/**
+ * Test for ResourceRequest.
+ */
 public final class ResourceRequestTest {
 
   @Test()

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/89435324/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/package-info.java
----------------------------------------------------------------------
diff --git 
a/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/package-info.java
 
b/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/package-info.java
index 2778f33..cb220f6 100644
--- 
a/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/package-info.java
+++ 
b/lang/java/reef-runtime-local/src/test/java/org/apache/reef/runtime/local/driver/package-info.java
@@ -17,6 +17,6 @@
  * under the License.
  */
 /**
- * TODO: Document.
+ * Test for the resource manager for the local runtime.
  */
 package org.apache.reef.runtime.local.driver;

Reply via email to