AndrewJSchofield commented on code in PR #20415:
URL: https://github.com/apache/kafka/pull/20415#discussion_r2307483756


##########
docs/upgrade.html:
##########
@@ -41,9 +43,51 @@ <h5><a id="upgrade_420_notable" 
href="#upgrade_420_notable">Notable changes in 4
         The <code>PARTITIONER_ADPATIVE_PARTITIONING_ENABLE_CONFIG</code> in 
<code>ProducerConfig</code> was deprecated and will be removed in Kafka 5.0. 
Please use the <code>PARTITIONER_ADAPTIVE_PARTITIONING_ENABLE_CONFIG</code> 
instead.
     </li>
     <li>
-        The <code>ConsumerPerformance</code> command line tool has a new 
<code>include</code> option that is alternative to the <code>topic</code> 
option.
+        The <code>ConsumerPerformance</code> command line tool has a new 
<code>--include</code> option that is an alternative to the 
<code>--topic</code> option.
         This new option allows to pass a regular expression specifying a list 
of topics to include for consumption, which is useful to test consumer 
performance across multiple topics or dynamically matching topic sets.
     </li>
+    <li>
+        The consistency of argument names for the command-line tools has been 
improved (<a href="https://cwiki.apache.org/confluence/x/DguWF";>KIP-1147</a>).
+        The deprecated options will be removed in Kafka 5.0.
+        <ul>
+            <li>
+                A new <code>--bootstrap-server</code> option is added to 
<code>kafka-producer-perf-test.sh</code>.
+            </li>
+            <li>
+                A new <code>--reporting-interval</code> option is added to 
<code>kafka-producer-perf-test.sh</code>.
+            </li>
+            <li>
+                The option <code>--command-property</code> is used for all 
command-line tools which accept configuration properties directly on
+                the command line. The tools affected are 
<code>kafka-console-consumer.sh</code>, <code>kafka-console-producer.sh</code> 
and
+                <code>kafka-console-share-consumer.sh</code> 
(<code>--consumer-property</code> and <code>--producer-property</code> are
+                deprecated in favor of <code>--command-property</code>); and 
<code>kafka-producer-perf-test.sh</code> (<code>--producer-props</code>
+                is deprecated in favor of <code>--command-property</code>. In 
addition, <code>--command-property</code> is added to
+                <code>kafka-consumer-perf-test.sh</code> and 
<code>kafka-share-consumer-perf-test.sh</code> to bring all performance testing 
tools
+                in line.
+            </li>
+            <li>
+                The option <code>--command-config</code> is used for all 
command-line tools which accept a file of configuration properties.
+                The tools affected are <code>kafka-cluster.sh</code> 
(<code>--config</code> deprecated in favor of
+                <code>--command-config</code>); 
<code>kafka-console-consumer.sh</code>, <code>kafka-console-producer.sh</code> 
and
+                <code>kafka-console-share-consumer.sh</code> 
(<code>--consumer.config</code> and <code>--producer.config</code> deprecated 
in favor of
+                <code>--command-config</code>); 
<code>kafka-consumer-perf-test.sh</code> (<code>--consumer.config</code> 
deprecated in favor of
+                <code>--command-config</code>); 
<code>kafka-producer-perf-test.sh</code> (<code>--producer.config</code> 
deprecated in favor of
+                <code>--command-config</code>); 
<code>kafka-share-consumer-perf-test.sh</code> (<code>--consumer.config</code> 
deprecated in favor of
+                <code>--command-config</code>); 
<code>kafka-verifiable-consumer.sh</code> and 
<code>kafka-verifiable-producer.sh</code>
+                (<code>--consumer.config</code> and 
<code>--producer.config</code> deprecated in favor of 
<code>--command-config</code>);
+                <code>kafka-leader-election.sh</code> 
(<code>--admin.config</code> deprecated in favor of 
<code>--command-config</code>); and
+                <code>kafka-streams-application-reset.sh</code> 
(<code>--config-file</code> deprecated in favor of 
<code>--command-config</code>).

Review Comment:
   Syntactically, it makes sense. However, practically, yes, I think you're 
right. I'll listify it.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to