You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by ey...@apache.org on 2019/03/20 19:46:23 UTC
[hadoop] branch trunk updated: YARN-9398. Fixed javadoc errors for
FPGA related java files. Contributed by Peter Bacsko
This is an automated email from the ASF dual-hosted git repository.
eyang pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/hadoop.git
The following commit(s) were added to refs/heads/trunk by this push:
new f2b862c YARN-9398. Fixed javadoc errors for FPGA related java files. Contributed by Peter Bacsko
f2b862c is described below
commit f2b862cac666217ccb77f49776c54191035b13c4
Author: Eric Yang <ey...@apache.org>
AuthorDate: Wed Mar 20 15:45:37 2019 -0400
YARN-9398. Fixed javadoc errors for FPGA related java files.
Contributed by Peter Bacsko
---
.../resourceplugin/fpga/AbstractFpgaVendorPlugin.java | 7 +++++++
.../containermanager/resourceplugin/fpga/FpgaDiscoverer.java | 7 +++++--
.../resourceplugin/fpga/IntelFpgaOpenclPlugin.java | 2 +-
3 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/AbstractFpgaVendorPlugin.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/AbstractFpgaVendorPlugin.java
index d238c67..aa50d23 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/AbstractFpgaVendorPlugin.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/AbstractFpgaVendorPlugin.java
@@ -42,11 +42,16 @@ public interface AbstractFpgaVendorPlugin {
/**
* Check vendor's toolchain and required environment
+ * @param conf Hadoop configuration
+ * @return true if the initialization was successful
* */
boolean initPlugin(Configuration conf);
/**
* Diagnose the devices using vendor toolchain but no need to parse device information
+ *
+ * @param timeout timeout in milliseconds
+ * @return true if the diagnostics was successful
* */
boolean diagnose(int timeout);
@@ -60,6 +65,8 @@ public interface AbstractFpgaVendorPlugin {
/**
* Since all vendor plugins share a {@link org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.fpga.FpgaResourceAllocator}
* which distinguish FPGA devices by type. Vendor plugin must report this.
+ *
+ * @return the type of FPGA plugin represented as a string
* */
String getFpgaType();
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/FpgaDiscoverer.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/FpgaDiscoverer.java
index 32b88b2..ecc2934 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/FpgaDiscoverer.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/FpgaDiscoverer.java
@@ -114,8 +114,11 @@ public class FpgaDiscoverer {
}
/**
- * get avialable devices minor numbers from toolchain or static configuration
- * */
+ * Get available devices minor numbers from toolchain or static configuration.
+ *
+ * @return the list of FPGA devices
+ * @throws ResourceHandlerException if there's any error during discovery
+ **/
public List<FpgaResourceAllocator.FpgaDevice> discover()
throws ResourceHandlerException {
List<FpgaResourceAllocator.FpgaDevice> list;
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/IntelFpgaOpenclPlugin.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/IntelFpgaOpenclPlugin.java
index f6a8cff..19826d0 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/IntelFpgaOpenclPlugin.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/resourceplugin/fpga/IntelFpgaOpenclPlugin.java
@@ -153,7 +153,7 @@ public class IntelFpgaOpenclPlugin implements AbstractFpgaVendorPlugin {
}
/**
- * Helper class to run aocl diagnose & determine major/minor numbers.
+ * Helper class to run aocl diagnose & determine major/minor numbers.
*/
public static class InnerShellExecutor {
---------------------------------------------------------------------
To unsubscribe, e-mail: common-commits-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-commits-help@hadoop.apache.org