Uploaded image for project: 'OpenDJ'
  1. OpenDJ
  2. OPENDJ-7249

In dsrepl subcommand --help, group options to make it easier to find the specific ones.

    Details

    • Type: Improvement
    • Status: Done
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: 7.0.0
    • Fix Version/s: 7.0.0
    • Component/s: tools

      Description

      When trying to understand the options for dsrepl subcommands, too many options are displayed for each subcommand and it's hard to find the really specific and relevant ones.

      For example, dsrepl status --help starts with displaying this:

      Usage: dsrepl {options} status {options}
      Displays a list with the basic replication configuration of the base DNs of the
      servers defined in the registration information. If no base DNs are specified
      as parameter the information for all base DNs is displayed
      
      Global Options:
       See "dsrepl --help"
      SubCommand Options:
      ...
      

      And in the Subcommand options, there are 27 options, in alphabetic order.

      I think it's important to have groups and display the most relevant ones first.

      Such as the ones that affect display vs the ones for connection and security.

      -b, --baseDn {baseDN}
       Base DN(s) to display. Multiple base DNs can be provided by using this
       option multiple times. If no base DNs are provided, then all the base DNs
       will be displayed.
      --showChangelogs
       Displays individual changelog servers in the output
      --showGroups
       Display replication group information in the output
      --showReplicas
       Displays individual replicas in the output
      

        Attachments

          Activity

            People

            • Assignee:
              ondrej.fuchsik Ondrej Fuchsik
              Reporter:
              ludo Ludovic Poitou
              Dev Assignee:
              Jean-Noël Rouvignac
              QA Assignee:
              Ondrej Fuchsik
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: