kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gwens...@apache.org
Subject kafka git commit: MINOR: Remove the very misleading comment lines
Date Tue, 22 Mar 2016 18:58:09 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk 99cfb99aa -> 73470b028


MINOR: Remove the very misleading comment lines

It is not true in practice. Maybe the implied feature is not yet implemented or removed.
These lines can be super misleading.

Please merge.
Thank you.

Author: gaob13 <gaob13@mails.tsinghua.edu.cn>

Reviewers: Ismael Juma, Ewen Cheslack-Postava

Closes #793 from gaob13/trunk


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

Branch: refs/heads/trunk
Commit: 73470b028cd659c1c405e6b6ba52bf483113b90b
Parents: 99cfb99
Author: gaob13 <gaob13@mails.tsinghua.edu.cn>
Authored: Tue Mar 22 11:58:01 2016 -0700
Committer: Gwen Shapira <cshapi@gmail.com>
Committed: Tue Mar 22 11:58:01 2016 -0700

----------------------------------------------------------------------
 config/server.properties                        | 30 +++++++++-----------
 .../main/scala/kafka/server/KafkaConfig.scala   | 20 +++++++++----
 2 files changed, 28 insertions(+), 22 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/73470b02/config/server.properties
----------------------------------------------------------------------
diff --git a/config/server.properties b/config/server.properties
index ddb695a..aebcb87 100644
--- a/config/server.properties
+++ b/config/server.properties
@@ -21,22 +21,18 @@ broker.id=0
 
 ############################# Socket Server Settings #############################
 
-listeners=PLAINTEXT://:9092
-
-# The port the socket server listens on
-#port=9092
-
-# Hostname the broker will bind to. If not set, the server will bind to all interfaces
-#host.name=localhost
-
-# Hostname the broker will advertise to producers and consumers. If not set, it uses the
-# value for "host.name" if configured.  Otherwise, it will use the value returned from
-# java.net.InetAddress.getCanonicalHostName().
-#advertised.host.name=<hostname routable by clients>
-
-# The port to publish to ZooKeeper for clients to use. If this is not set,
-# it will publish the same port that the broker binds to.
-#advertised.port=<port accessible by clients>
+# The address the socket server listens on. It will get the value returned from 
+# java.net.InetAddress.getCanonicalHostName() if not configured.
+#   FORMAT:
+#     listeners = security_protocol://host_name:port
+#   EXAMPLE:
+#     listeners = PLAINTEXT://your.host.name:9092
+#listeners=PLAINTEXT://:9092
+
+# Hostname and port the broker will advertise to producers and consumers. If not set, 
+# it uses the value for "listeners" if configured.  Otherwise, it will use the value
+# returned from java.net.InetAddress.getCanonicalHostName().
+#advertised.listeners=PLAINTEXT://your.host.name:9092
 
 # The number of threads handling network requests
 num.network.threads=3
@@ -117,3 +113,5 @@ zookeeper.connect=localhost:2181
 
 # Timeout in ms for connecting to zookeeper
 zookeeper.connection.timeout.ms=6000
+
+

http://git-wip-us.apache.org/repos/asf/kafka/blob/73470b02/core/src/main/scala/kafka/server/KafkaConfig.scala
----------------------------------------------------------------------
diff --git a/core/src/main/scala/kafka/server/KafkaConfig.scala b/core/src/main/scala/kafka/server/KafkaConfig.scala
index 7e1013e..a6018ad 100755
--- a/core/src/main/scala/kafka/server/KafkaConfig.scala
+++ b/core/src/main/scala/kafka/server/KafkaConfig.scala
@@ -366,24 +366,32 @@ object KafkaConfig {
   /************* Authorizer Configuration ***********/
   val AuthorizerClassNameDoc = "The authorizer class that should be used for authorization"
   /** ********* Socket Server Configuration ***********/
-  val PortDoc = "the port to listen and accept connections on"
-  val HostNameDoc = "hostname of broker. If this is set, it will only bind to this address.
If this is not set, it will bind to all interfaces"
+  val PortDoc = "DEPRECATED: only used when `listeners` is not set. " +
+  "Use `listeners` instead. \n" + 
+  "the port to listen and accept connections on"
+  val HostNameDoc = "DEPRECATED: only used when `listeners` is not set. " +
+  "Use `listeners` instead. \n" +
+  "hostname of broker. If this is set, it will only bind to this address. If this is not
set, it will bind to all interfaces"
   val ListenersDoc = "Listener List - Comma-separated list of URIs we will listen on and
their protocols.\n" +
   " Specify hostname as 0.0.0.0 to bind to all interfaces.\n" +
   " Leave hostname empty to bind to default interface.\n" +
   " Examples of legal listener lists:\n" +
   " PLAINTEXT://myhost:9092,TRACE://:9091\n" +
   " PLAINTEXT://0.0.0.0:9092, TRACE://localhost:9093\n"
-  val AdvertisedHostNameDoc = "Hostname to publish to ZooKeeper for clients to use. In IaaS
environments, this may " +
+  val AdvertisedHostNameDoc = "DEPRECATED: only used when `advertised.listeners` or `listeners`
are not set. " +
+  "Use `advertised.listeners` instead. \n" +
+  "Hostname to publish to ZooKeeper for clients to use. In IaaS environments, this may "
+
   "need to be different from the interface to which the broker binds. If this is not set,
" +
-  "it will use the value for \"host.name\" if configured. Otherwise " +
+  "it will use the value for `host.name` if configured. Otherwise " +
   "it will use the value returned from java.net.InetAddress.getCanonicalHostName()."
-  val AdvertisedPortDoc = "The port to publish to ZooKeeper for clients to use. In IaaS environments,
this may " +
+  val AdvertisedPortDoc = "DEPRECATED: only used when `advertised.listeners` or `listeners`
are not set. " +
+  "Use `advertised.listeners` instead. \n" +
+  "The port to publish to ZooKeeper for clients to use. In IaaS environments, this may "
+
   "need to be different from the port to which the broker binds. If this is not set, " +
   "it will publish the same port that the broker binds to."
   val AdvertisedListenersDoc = "Listeners to publish to ZooKeeper for clients to use, if
different than the listeners above." +
   " In IaaS environments, this may need to be different from the interface to which the broker
binds." +
-  " If this is not set, the value for \"listeners\" will be used."
+  " If this is not set, the value for `listeners` will be used."
   val SocketSendBufferBytesDoc = "The SO_SNDBUF buffer of the socket sever sockets"
   val SocketReceiveBufferBytesDoc = "The SO_RCVBUF buffer of the socket sever sockets"
   val SocketRequestMaxBytesDoc = "The maximum number of bytes in a socket request"


Mime
View raw message