Uploaded image for project: 'JBoss Server Migration Tool'
  1. JBoss Server Migration Tool
  2. CMTOOL-136

jboss-server-migration help content improvements (UX)

XMLWordPrintable

    • Icon: Improvement Improvement
    • Resolution: Done
    • Icon: Major Major
    • 1.0.0.Final
    • 1.0.0.Final
    • CLI
    • None
    • User Experience

      We should improve the help message content a little bit.

      Current content:

      Usage: server-migration.sh [args...]
      where args include:
          --environment <value>               Path to the properties file containing 
                                              the user environment.
      
      
          --interactive <value>               Indicates if the migration tool should 
                                              interact (or not) with the user. Value 
                                              should either be true or false.
      
      
          --source <value>                    Path to the base dir of the server to 
                                              migrate from.
      
      
          --target <value>                    Path to the base dir of the server to 
                                              migrate to.
      
      

      1) "Usage: server-migration.sh [args...]"
      The name of the script is jboss-server-migration not server-migration - jboss-server-migration.[bat|sh] should be used
      2) --source is mandatory
      --source argument is mandatory, it should be either added to Usage string or this should be mentioned in --target argument description.
      3) Default values should be mentioned in argument description sections (e.g. interactive is false by default, location of default environment.properties used by the tool, ...)

              rhn-support-iweiss Ingo Weiss
              rhn-support-iweiss Ingo Weiss
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: