git commit: [SPARK-1981][Streaming][Hotfix] Fixed docs related to kinesis
Repository: spark
Updated Branches:
refs/heads/master aa7de128c - e9bb12bea
[SPARK-1981][Streaming][Hotfix] Fixed docs related to kinesis
- Include kinesis in the unidocs
- Hide non-public classes from docs
Author: Tathagata Das tathagata.das1...@gmail.com
Closes #2239 from tdas/kinesis-doc-fix and squashes the following commits:
156e20c [Tathagata Das] More fixes, based on PR comments.
e9a6c01 [Tathagata Das] Fixed docs related to kinesis
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/e9bb12be
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/e9bb12be
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/e9bb12be
Branch: refs/heads/master
Commit: e9bb12bea9fbef94332fbec88e3cd9197a27b7ad
Parents: aa7de12
Author: Tathagata Das tathagata.das1...@gmail.com
Authored: Tue Sep 2 19:02:48 2014 -0700
Committer: Tathagata Das tathagata.das1...@gmail.com
Committed: Tue Sep 2 19:02:48 2014 -0700
--
docs/_plugins/copy_api_dirs.rb| 4 ++--
.../spark/examples/streaming/JavaKinesisWordCountASL.java | 10 +-
.../spark/examples/streaming/KinesisWordCountASL.scala| 6 +++---
.../org/apache/spark/streaming/kinesis/KinesisUtils.scala | 7 ---
project/SparkBuild.scala | 6 +++---
5 files changed, 17 insertions(+), 16 deletions(-)
--
http://git-wip-us.apache.org/repos/asf/spark/blob/e9bb12be/docs/_plugins/copy_api_dirs.rb
--
diff --git a/docs/_plugins/copy_api_dirs.rb b/docs/_plugins/copy_api_dirs.rb
index 2dbbbf6..3b02e09 100644
--- a/docs/_plugins/copy_api_dirs.rb
+++ b/docs/_plugins/copy_api_dirs.rb
@@ -25,8 +25,8 @@ if not (ENV['SKIP_API'] == '1' or ENV['SKIP_SCALADOC'] == '1')
curr_dir = pwd
cd(..)
- puts Running 'sbt/sbt compile unidoc' from + pwd + ; this may take a few
minutes...
- puts `sbt/sbt compile unidoc`
+ puts Running 'sbt/sbt -Pkinesis-asl compile unidoc' from + pwd + ; this
may take a few minutes...
+ puts `sbt/sbt -Pkinesis-asl compile unidoc`
puts Moving back into docs dir.
cd(docs)
http://git-wip-us.apache.org/repos/asf/spark/blob/e9bb12be/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
--
diff --git
a/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
b/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
index 1a710d7..aa917d0 100644
---
a/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
+++
b/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
@@ -75,7 +75,7 @@ import com.google.common.collect.Lists;
* onto the Kinesis stream.
* Usage instructions for KinesisWordCountProducerASL are provided in the
class definition.
*/
-public final class JavaKinesisWordCountASL {
+public final class JavaKinesisWordCountASL { // needs to be public for access
from run-example
private static final Pattern WORD_SEPARATOR = Pattern.compile( );
private static final Logger logger =
Logger.getLogger(JavaKinesisWordCountASL.class);
@@ -87,10 +87,10 @@ public final class JavaKinesisWordCountASL {
/* Check that all required args were passed in. */
if (args.length 2) {
System.err.println(
- |Usage: KinesisWordCount stream-name endpoint-url\n +
- |stream-name is the name of the Kinesis stream\n +
- |endpoint-url is the endpoint of the Kinesis service\n +
- | (e.g.
https://kinesis.us-east-1.amazonaws.com)\n);
+ Usage: JavaKinesisWordCountASL stream-name endpoint-url\n +
+ stream-name is the name of the Kinesis stream\n +
+ endpoint-url is the endpoint of the Kinesis service\n +
+ (e.g.
https://kinesis.us-east-1.amazonaws.com)\n);
System.exit(1);
}
http://git-wip-us.apache.org/repos/asf/spark/blob/e9bb12be/extras/kinesis-asl/src/main/scala/org/apache/spark/examples/streaming/KinesisWordCountASL.scala
--
diff --git
a/extras/kinesis-asl/src/main/scala/org/apache/spark/examples/streaming/KinesisWordCountASL.scala
b/extras/kinesis-asl/src/main/scala/org/apache/spark/examples/streaming/KinesisWordCountASL.scala
index d03edf8..fffd90d 100644
---
a/extras/kinesis-asl/src/main/scala/org/apache/spark/examples/streaming/KinesisWordCountASL.scala
+++
git commit: [SPARK-1981][Streaming][Hotfix] Fixed docs related to kinesis
Repository: spark
Updated Branches:
refs/heads/branch-1.1 9b0cff2d4 - 0c8183cb3
[SPARK-1981][Streaming][Hotfix] Fixed docs related to kinesis
- Include kinesis in the unidocs
- Hide non-public classes from docs
Author: Tathagata Das tathagata.das1...@gmail.com
Closes #2239 from tdas/kinesis-doc-fix and squashes the following commits:
156e20c [Tathagata Das] More fixes, based on PR comments.
e9a6c01 [Tathagata Das] Fixed docs related to kinesis
(cherry picked from commit e9bb12bea9fbef94332fbec88e3cd9197a27b7ad)
Signed-off-by: Tathagata Das tathagata.das1...@gmail.com
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/0c8183cb
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/0c8183cb
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/0c8183cb
Branch: refs/heads/branch-1.1
Commit: 0c8183cb30b69902cb6fef220980ea51c4533396
Parents: 9b0cff2
Author: Tathagata Das tathagata.das1...@gmail.com
Authored: Tue Sep 2 19:02:48 2014 -0700
Committer: Tathagata Das tathagata.das1...@gmail.com
Committed: Tue Sep 2 19:03:04 2014 -0700
--
docs/_plugins/copy_api_dirs.rb| 4 ++--
.../spark/examples/streaming/JavaKinesisWordCountASL.java | 10 +-
.../spark/examples/streaming/KinesisWordCountASL.scala| 6 +++---
.../org/apache/spark/streaming/kinesis/KinesisUtils.scala | 7 ---
project/SparkBuild.scala | 6 +++---
5 files changed, 17 insertions(+), 16 deletions(-)
--
http://git-wip-us.apache.org/repos/asf/spark/blob/0c8183cb/docs/_plugins/copy_api_dirs.rb
--
diff --git a/docs/_plugins/copy_api_dirs.rb b/docs/_plugins/copy_api_dirs.rb
index 2dbbbf6..3b02e09 100644
--- a/docs/_plugins/copy_api_dirs.rb
+++ b/docs/_plugins/copy_api_dirs.rb
@@ -25,8 +25,8 @@ if not (ENV['SKIP_API'] == '1' or ENV['SKIP_SCALADOC'] == '1')
curr_dir = pwd
cd(..)
- puts Running 'sbt/sbt compile unidoc' from + pwd + ; this may take a few
minutes...
- puts `sbt/sbt compile unidoc`
+ puts Running 'sbt/sbt -Pkinesis-asl compile unidoc' from + pwd + ; this
may take a few minutes...
+ puts `sbt/sbt -Pkinesis-asl compile unidoc`
puts Moving back into docs dir.
cd(docs)
http://git-wip-us.apache.org/repos/asf/spark/blob/0c8183cb/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
--
diff --git
a/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
b/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
index a8b907b..f36952b 100644
---
a/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
+++
b/extras/kinesis-asl/src/main/java/org/apache/spark/examples/streaming/JavaKinesisWordCountASL.java
@@ -75,7 +75,7 @@ import com.google.common.collect.Lists;
* onto the Kinesis stream.
* Usage instructions for KinesisWordCountProducerASL are provided in the
class definition.
*/
-public final class JavaKinesisWordCountASL {
+public final class JavaKinesisWordCountASL { // needs to be public for access
from run-example
private static final Pattern WORD_SEPARATOR = Pattern.compile( );
private static final Logger logger =
Logger.getLogger(JavaKinesisWordCountASL.class);
@@ -87,10 +87,10 @@ public final class JavaKinesisWordCountASL {
/* Check that all required args were passed in. */
if (args.length 2) {
System.err.println(
- |Usage: KinesisWordCount stream-name endpoint-url\n +
- |stream-name is the name of the Kinesis stream\n +
- |endpoint-url is the endpoint of the Kinesis service\n +
- | (e.g.
https://kinesis.us-east-1.amazonaws.com)\n);
+ Usage: JavaKinesisWordCountASL stream-name endpoint-url\n +
+ stream-name is the name of the Kinesis stream\n +
+ endpoint-url is the endpoint of the Kinesis service\n +
+ (e.g.
https://kinesis.us-east-1.amazonaws.com)\n);
System.exit(1);
}
http://git-wip-us.apache.org/repos/asf/spark/blob/0c8183cb/extras/kinesis-asl/src/main/scala/org/apache/spark/examples/streaming/KinesisWordCountASL.scala
--
diff --git
a/extras/kinesis-asl/src/main/scala/org/apache/spark/examples/streaming/KinesisWordCountASL.scala
b/extras/kinesis-asl/src/main/scala/org/apache/spark/examples/streaming/KinesisWordCountASL.scala
index d03edf8..fffd90d 100644
---
