Uploaded image for project: 'Daffodil'
  1. Daffodil
  2. DFDL-750

CLI Debugger: Minor Typos/Issues in 'help' output

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.0.0
    • Component/s: Debugger
    • Labels:
      None

      Description

      'help condition'
      "If the result of the DFDL expressions is not a boolean value, it is treated as false."

      In the wiki under Arguments for 'help display':
      "<debugger command>"
      In the output for the actual 'help display' command:
      "<debugger_command>"

      The output for some commands seems a little redundant now. e.g. 'help enable':

      (debug) help enable
        Usage: e[nable] <type> <id>
        
        Enable a breakpoint or display. Valid values for <type> are "breakpoint"
        and "display".
        
        Example: enable breakpoint 1
                 enable display 1
        
        Subcommands:
          breakpoint  enable a breakpoint
          display     enable a display

      The description explains that the value values for "type" are breakpoint and display. The example then shows the use of 'breakpoint' and 'display'. Then the subcommands section reiterates the two options. It might be confusing to the user that 'breakpoint' and 'display' are referred to within this help as both "types" and "subcommands". It might be best to pick one and stick with it, removing the other.

      description for 'path' within wiki entry for 'info'
      "display the schema component designator"
      description in actual 'help info' command:
      "display the current schema component designator/path"

      The output of 'help info' for Subcommands has the short form in the wiki but not in the actual output.

      breakOnFailure description has typos in both wiki and actual output:
      wiki:
      Set whether or the debugger should break on failures. If set to false
      the normal processing occurs. If set to true, any errors cause a break. Note that due to the backtracking behavior, not all failures are fatal.
      output:
      whether or not stop break on failures

      breakOnlyOnCreation:
      wiki mentions "<value> must be either true/false or 1/0. "
      help output does not

      dataLength:
      wiki mentions "This only affects the 'info data' command."
      help output does not

      infosetLines:
      wiki has much more detail: "This only affects the 'info infoset' command. This shows the last <value> lines of the infoset. If <value> is less than or equal to zero, the entire infoset is printed."

      removeHidden:
      similar to issues above. much less info than in the wiki. This might be acceptable.

        Gliffy Diagrams

          Attachments

            Activity

              People

              Assignee:
              efinnegan Elizabeth Finnegan
              Reporter:
              jchab Jessie Chab
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Tasks

                  Progress: 
                   0/0