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

Man pages generation does not work with '-H' or '--help' for tools which support subcommands

    Details

    • Type: Bug
    • Status: Done
    • Priority: Minor
    • Resolution: Won't Fix
    • Affects Version/s: 4.0.0
    • Fix Version/s: Not applicable
    • Component/s: documentation
    • Labels:
      None

      Description

      *Given*
      A fresh opendj archive and the OPENDJ_JAVA_ARGS set to -Dorg.forgerock.opendj.gendoc=true
      *When*
      Trying to generate the xml ref entries for a tool which support sub commands, such as:

      bin/dsconfig --help
      

      Note that you need to add the freemarker jar to make this works, otherwise you'll got a NoClassDefFoundError
      *Then*
      The system property is ignored and the tool prints user friendly help text in standard output.

      The issue is located in the SubCommandArgumentParser#parseArguments() method which calls different getUsage(...) methods whether the help argument is '?', 'H' or '-help'.
      The only one which works at the moment is '?'.

        Attachments

          Activity

            People

            • Assignee:
              matthew Matthew Swift
              Reporter:
              gaetan Gaetan Boismal [X] (Inactive)
              Dev Assignee:
              Matthew Swift
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: