Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-1292

Command-line tools should print what they do as part of their usage command

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:

      Description

      It would be nice if you could get an explanation for each tool by running the command with no arguments. Something like bin/kafka-preferred-replica-election.sh is a little scary so it would be nice to have it self-describe:
      > bin/kafka-preferred-replica-election.sh
      This command attempts to return leadership to the preferred replicas (if they are alive) from whomever is currently the leader).
      Option Description
      ------ -----------
      --alter Alter the configuration for the topic.
      ...

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              jkreps Jay Kreps
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: