From b548017ccca50f61231d2360b6d44bd45cb9447b Mon Sep 17 00:00:00 2001 From: Takuya UESHIN Date: Sun, 2 Nov 2014 11:21:54 +0900 Subject: [PATCH 1/6] Disable doclint in Java 8 to prevent from build error. --- pom.xml | 19 +++++++++++++++++++ project/SparkBuild.scala | 7 ++++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 6191cd3a541e2..c18a1d6ecd32e 100644 --- a/pom.xml +++ b/pom.xml @@ -1174,6 +1174,25 @@ + + doclint-java8-disable + + [1.8,) + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + + -Xdoclint:none + + + + + + returns StreamId = 100 + * client.sendRPC(new OpenFile("/foo")) --> returns StreamId = 100 * client.fetchChunk(streamId = 100, chunkIndex = 0, callback) * client.fetchChunk(streamId = 100, chunkIndex = 1, callback) * ... diff --git a/network/common/src/main/java/org/apache/spark/network/server/OneForOneStreamManager.java b/network/common/src/main/java/org/apache/spark/network/server/OneForOneStreamManager.java index 731d48d4d9c6c..a6d390e13f396 100644 --- a/network/common/src/main/java/org/apache/spark/network/server/OneForOneStreamManager.java +++ b/network/common/src/main/java/org/apache/spark/network/server/OneForOneStreamManager.java @@ -29,7 +29,7 @@ import org.apache.spark.network.buffer.ManagedBuffer; /** - * StreamManager which allows registration of an Iterator, which are individually + * StreamManager which allows registration of an Iterator<ManagedBuffer>, which are individually * fetched as chunks by the client. Each registered buffer is one chunk. */ public class OneForOneStreamManager extends StreamManager { diff --git a/network/common/src/main/java/org/apache/spark/network/util/NettyUtils.java b/network/common/src/main/java/org/apache/spark/network/util/NettyUtils.java index b1872341198e0..38665953e3310 100644 --- a/network/common/src/main/java/org/apache/spark/network/util/NettyUtils.java +++ b/network/common/src/main/java/org/apache/spark/network/util/NettyUtils.java @@ -92,7 +92,7 @@ public static ByteToMessageDecoder createFrameDecoder() { return new LengthFieldBasedFrameDecoder(Integer.MAX_VALUE, 0, 8, -8, 8); } - /** Returns the remote address on the channel or "" if none exists. */ + /** Returns the remote address on the channel or "<remote address>" if none exists. */ public static String getRemoteAddress(Channel channel) { if (channel != null && channel.remoteAddress() != null) { return channel.remoteAddress().toString(); From 923e2f0bffb40302a72d72f3f3a1251fc57e1323 Mon Sep 17 00:00:00 2001 From: Takuya UESHIN Date: Tue, 4 Nov 2014 23:25:15 +0900 Subject: [PATCH 3/6] Use doclint option `-missing` instead of `none`. --- pom.xml | 2 +- project/SparkBuild.scala | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index c18a1d6ecd32e..69b2ee3e93880 100644 --- a/pom.xml +++ b/pom.xml @@ -1186,7 +1186,7 @@ org.apache.maven.plugins maven-javadoc-plugin - -Xdoclint:none + -Xdoclint:-missing diff --git a/project/SparkBuild.scala b/project/SparkBuild.scala index ad51fffca8697..e6116b2e48183 100644 --- a/project/SparkBuild.scala +++ b/project/SparkBuild.scala @@ -130,7 +130,7 @@ object SparkBuild extends PomBuild { javacOptions in (Compile, doc) ++= { val Array(major, minor, _) = System.getProperty("java.version").split("\\.", 3) - if (major.toInt >= 1 && minor.toInt >= 8) Seq("-Xdoclint:none") else Seq.empty + if (major.toInt >= 1 && minor.toInt >= 8) Seq("-Xdoclint:-missing") else Seq.empty } ) From fdb280ae506ec6fdc151f8733accf36381592e74 Mon Sep 17 00:00:00 2001 From: Takuya UESHIN Date: Wed, 26 Nov 2014 10:28:21 +0900 Subject: [PATCH 4/6] Fix Javadoc errors. --- .../java/org/apache/spark/network/util/LimitedInputStream.java | 2 +- .../main/java/org/apache/spark/network/util/TransportConf.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/network/common/src/main/java/org/apache/spark/network/util/LimitedInputStream.java b/network/common/src/main/java/org/apache/spark/network/util/LimitedInputStream.java index 63ca43c046525..57113ed12d414 100644 --- a/network/common/src/main/java/org/apache/spark/network/util/LimitedInputStream.java +++ b/network/common/src/main/java/org/apache/spark/network/util/LimitedInputStream.java @@ -27,7 +27,7 @@ * Wraps a {@link InputStream}, limiting the number of bytes which can be read. * * This code is from Guava's 14.0 source code, because there is no compatible way to - * use this functionality in both a Guava 11 environment and a Guava >14 environment. + * use this functionality in both a Guava 11 environment and a Guava >14 environment. */ public final class LimitedInputStream extends FilterInputStream { private long left; diff --git a/network/common/src/main/java/org/apache/spark/network/util/TransportConf.java b/network/common/src/main/java/org/apache/spark/network/util/TransportConf.java index 621427d8cba5e..1af40acf8b4af 100644 --- a/network/common/src/main/java/org/apache/spark/network/util/TransportConf.java +++ b/network/common/src/main/java/org/apache/spark/network/util/TransportConf.java @@ -72,7 +72,7 @@ public int connectionTimeoutMs() { /** * Time (in milliseconds) that we will wait in order to perform a retry after an IOException. - * Only relevant if maxIORetries > 0. + * Only relevant if maxIORetries > 0. */ public int ioRetryWaitTime() { return conf.getInt("spark.shuffle.io.retryWaitMs", 5000); } From 6762ec2d81827bc5a7be546200c951aba4a7bba0 Mon Sep 17 00:00:00 2001 From: Takuya UESHIN Date: Wed, 26 Nov 2014 12:36:40 +0900 Subject: [PATCH 5/6] Fix usage of -Xdoclint javadoc option. --- pom.xml | 2 +- project/SparkBuild.scala | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index 9423f3d5e78c7..270a91f1cad69 100644 --- a/pom.xml +++ b/pom.xml @@ -1254,7 +1254,7 @@ org.apache.maven.plugins maven-javadoc-plugin - -Xdoclint:-missing + -Xdoclint:all -Xdoclint:-missing diff --git a/project/SparkBuild.scala b/project/SparkBuild.scala index 2806d14b30f05..b16ed66aeb3c3 100644 --- a/project/SparkBuild.scala +++ b/project/SparkBuild.scala @@ -140,7 +140,7 @@ object SparkBuild extends PomBuild { javacOptions in (Compile, doc) ++= { val Array(major, minor, _) = System.getProperty("java.version").split("\\.", 3) - if (major.toInt >= 1 && minor.toInt >= 8) Seq("-Xdoclint:-missing") else Seq.empty + if (major.toInt >= 1 && minor.toInt >= 8) Seq("-Xdoclint:all", "-Xdoclint:-missing") else Seq.empty } ) From e096bb13ffc13041b05a5f3cd640900383b0010c Mon Sep 17 00:00:00 2001 From: Takuya UESHIN Date: Wed, 26 Nov 2014 19:43:04 +0900 Subject: [PATCH 6/6] Add a plugin declaration to pluginManagement. --- pom.xml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pom.xml b/pom.xml index 270a91f1cad69..128f12cf250e9 100644 --- a/pom.xml +++ b/pom.xml @@ -1049,6 +1049,11 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.1 +