Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-104349

DB Upgrade Gogo command help messages are confusing

    Details

      Description

      First, I had a failure which dropped me into gogo shell. It gives you the helpful output:
      {{
      Type "help" to get available upgrade and verify commands.
      Type "help

      {command}

      " to get additional information about the command. For example, "help upgrade:list".
      Enter "exit" or "quit" to exit.
      g! help upgrade:list
      g! help upgrade
      g! help
      }}
      As you can see, my first command was to try the example which utterly fails. Why? Because there is an "upgrade" scope but no "list" command.
      It was only after the pure "help" command that I found that "verify" scope has a "list" command, not that it helps...

      So either the help text is wrong or the scope is wrong.
      Additionally, the documentation for many of the verify commands are just wrong:
      {{
      g! help verify:list

      list - Execute all registered verify processes
      scope: verify
      }}
      I doubt that list is actually supposed to execute anything.
      Others the documentation is really worthless, as is the output:
      {{
      g! help verify:showReports

      showReports - Show all available outputs
      scope: verify
      g! verify:showReports
      temp_file
      }}
      What is temp_file? What does that mean?
      {{
      g! help verify:show

      show - Show all registered verify processes
      scope: verify
      parameters:
      String
      g! verify:show
      gogo: IllegalArgumentException: Cannot coerce show() to any of [(String)]
      }}
      Okay, but what is the parameter supposed to be? If show shows all registered processes, why does it need a parameter? It fails if I don't provide a parameter, but I don't have any clue what to use for the argument.

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Days since last comment:
                10 weeks, 5 days ago

                Packages

                Version Package
                7.1.10 DXP FP16
                7.1.X
                7.2.X
                Master