[jira] [Commented] (KAFKA-7418) Add '--help' option to all available Kafka CLI commands (KIP-374)

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/KAFKA-7418?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16682757#comment-16682757 ] 

ASF GitHub Bot commented on KAFKA-7418:
---------------------------------------

mrsrinivas opened a new pull request #5898: KAFKA-7418 : Add '--help' option to missing Kafka commands (KIP-374)
URL: https://github.com/apache/kafka/pull/5898
 
 
   Changes made:
    - Checking for empty args or help option in command file to print Usage
    - Added new class to enforce help option to all commands
    - Refactored few lines (ex `PreferredReplicaLeaderElectionCommand`) to
      make use of `CommandDefaultOptions` attributes.
   
   *More detailed description of your change,
   if necessary. The PR title and PR message become
   the squashed commit message, so use a separate
   comment to ping reviewers.*
   
   *Summary of testing strategy (including rationale)
   for the feature or bug fix. Unit and/or integration
   tests are expected for any behaviour change and
   system tests should be considered for larger changes.*
   
   ### Committer Checklist (excluded from commit message)
   - [ ] Verify design and implementation 
   - [ ] Verify test coverage and CI build status
   - [ ] Verify documentation (including upgrade notes)
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Add '--help' option to all available Kafka CLI commands (KIP-374)
> -----------------------------------------------------------------
>
>                 Key: KAFKA-7418
>                 URL: https://issues.apache.org/jira/browse/KAFKA-7418
>             Project: Kafka
>          Issue Type: Improvement
>          Components: tools
>            Reporter: Attila Sasvari
>            Assignee: Srinivas Reddy
>            Priority: Major
>
> Currently, the '--help' option is not recognized by some Kafka commands . For example:
> {code}
> $ kafka-console-producer --help
> help is not a recognized option
> {code}
> However, the '--help' option is supported by other commands:
> {code}
> $ kafka-verifiable-producer --help
> usage: verifiable-producer [-h] --topic TOPIC --broker-list HOST1:PORT1[,HOST2:PORT2[...]] [--max-messages MAX-MESSAGES] [--throughput THROUGHPUT] [--acks ACKS]
>                            [--producer.config CONFIG_FILE] [--message-create-time CREATETIME] [--value-prefix VALUE-PREFIX]
> ...
> {code} 
> To provide a consistent user experience, it would be nice to add a '--help' option to all Kafka commands.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)