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

changelogstat option argument synopses should follow conventions

    Details

    • Type: Improvement
    • Status: Done
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 6.5.0
    • Fix Version/s: 6.5.0
    • Component/s: None
    • Labels:
      None

      Description

      The changelogstat command options synopses describe arguments with text rather than using placeholders as other commands do.

      For example, this is the current online help output for dump-change-number-db:

      $ ./opendj/bin/changelogstat dump-change-number-db --help
      Usage:  changelogstat  {options} dump-change-number-db {options}
      Dump the change number DB
      
      
      Global Options:
          See "changelogstat --help"
      
      SubCommand Options:
      --from The upper bound of change number range
          The lower bound of the range of change numbers to dump
      --outputDir The output directory
          The output directory for the dump files
      --to The upper bound of change number range
          The upper bound of the range of change numbers to dump

      If the online help followed the conventions of the other tools, the help would look more like this:

      $ ./opendj/bin/changelogstat dump-change-number-db --help
      Usage:  changelogstat  {options} dump-change-number-db {options}
      Dump the change number DB
      
      
      Global Options:
          See "changelogstat --help"
      
      SubCommand Options:
      --from {number}
          The lower bound of the range of change numbers to dump
      --outputDir {directory}
          The output directory for the dump files
      --to {number}
          The upper bound of the range of change numbers to dump

        Attachments

          Activity

            People

            • Assignee:
              joseph.de-menditte Joseph de-Menditte
              Reporter:
              Mark Mark Craig
              Dev Assignee:
              Joseph de-Menditte
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: