[kafka] branch 1.0 updated: KAFKA-7198: Enhance KafkaStreams start method javadoc. (#5763)

[mj...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mjsax pushed a commit to branch 1.0
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/1.0 by this push:
     new 98cf150  KAFKA-7198: Enhance KafkaStreams start method javadoc. (#5763)
98cf150 is described below

commit 98cf150bd8b4577e55b73bca304d0e86250c49b6
Author: Kamal Chandraprakash <ka...@gmail.com>
AuthorDate: Tue Oct 9 22:28:12 2018 +0530

    KAFKA-7198: Enhance KafkaStreams start method javadoc. (#5763)
    
    Reviewers: Bill Bejeck <bi...@confluent.io>, Matthias J. Sax <ma...@confluent.io>
---
 streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java | 1 +
 1 file changed, 1 insertion(+)

diff --git a/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java b/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
index 6f3c112..9d5bdab 100644
--- a/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
+++ b/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
@@ -733,6 +733,7 @@ public class KafkaStreams {
      * This function is expected to be called only once during the life cycle of the client.
      * <p>
      * Because threads are started in the background, this method does not block.
+     * However, if you have global stores in your topology, this method blocks until all global stores are restored.
      * As a consequence, any fatal exception that happens during processing is by default only logged.
      * If you want to be notified about dying threads, you can
      * {@link #setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler) register an uncaught exception handler}