You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by jg...@apache.org on 2017/05/24 16:14:23 UTC

kafka git commit: MINOR: Improve the help doc of consumer group command

Repository: kafka
Updated Branches:
  refs/heads/trunk 4d89db968 -> 88200938f


MINOR: Improve the help doc of consumer group command

Clarify the consumer group command help message around `zookeeper`, `bootstrap-server`, and `new-consumer` options.

Author: Vahid Hashemian <va...@us.ibm.com>

Reviewers: Jason Gustafson <ja...@confluent.io>

Closes #2046 from vahidhashemian/minor/improve_consumer_group_command_doc


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

Branch: refs/heads/trunk
Commit: 88200938f0c3ace5ec0bdb65a315ebd9b6adb4d0
Parents: 4d89db9
Author: Vahid Hashemian <va...@us.ibm.com>
Authored: Wed May 24 09:14:10 2017 -0700
Committer: Jason Gustafson <ja...@confluent.io>
Committed: Wed May 24 09:14:10 2017 -0700

----------------------------------------------------------------------
 core/src/main/scala/kafka/admin/ConsumerGroupCommand.scala | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/88200938/core/src/main/scala/kafka/admin/ConsumerGroupCommand.scala
----------------------------------------------------------------------
diff --git a/core/src/main/scala/kafka/admin/ConsumerGroupCommand.scala b/core/src/main/scala/kafka/admin/ConsumerGroupCommand.scala
index 69f0d8a..7715a95 100755
--- a/core/src/main/scala/kafka/admin/ConsumerGroupCommand.scala
+++ b/core/src/main/scala/kafka/admin/ConsumerGroupCommand.scala
@@ -676,9 +676,9 @@ object ConsumerGroupCommand extends Logging {
   }
 
   class ConsumerGroupCommandOptions(args: Array[String]) {
-    val ZkConnectDoc = "REQUIRED (only when using old consumer): The connection string for the zookeeper connection in the form host:port. " +
+    val ZkConnectDoc = "REQUIRED (for consumer groups based on the old consumer): The connection string for the zookeeper connection in the form host:port. " +
       "Multiple URLS can be given to allow fail-over."
-    val BootstrapServerDoc = "REQUIRED (unless old consumer is used): The server to connect to."
+    val BootstrapServerDoc = "REQUIRED (for consumer groups based on the new consumer): The server to connect to."
     val GroupDoc = "The consumer group we wish to act on."
     val TopicDoc = "The topic whose consumer group information should be deleted or topic whose should be included in the reset offset process. " +
       "In `reset-offsets` case, partitions can be specified using this format: `topic1:0,1,2`, where 0,1,2 are the partition to be included in the process. " +
@@ -694,7 +694,7 @@ object ConsumerGroupCommand extends Logging {
       "Pass in just a topic to delete the given topic's partition offsets and ownership information " +
       "for every consumer group. For instance --topic t1" + nl +
       "WARNING: Group deletion only works for old ZK-based consumer groups, and one has to use it carefully to only delete groups that are not active."
-    val NewConsumerDoc = "Use new consumer. This is the default."
+    val NewConsumerDoc = "Use new consumer. This option requires that the 'bootstrap-server' option is used."
     val TimeoutMsDoc = "The timeout that can be set for some use cases. For example, it can be used when describing the group " +
       "to specify the maximum amount of time in milliseconds to wait before the group stabilizes (when the group is just created, " +
       "or is going through some changes)."