Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-5661

Make WiredTiger utilities self documenting

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor - P4
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: WT10.0.0, 4.4.0-rc4, 4.7.0
    • Component/s: None
    • Labels:
      None
    • Story Points:
      5
    • Sprint:
      Storage - Tora 2020-04-20

      Description

      We should add explanations of the command line options to the wt utility so that they are self-documenting.
      eg:

      $ ./wt -h WT_TEST/test_hs06.test_hs06.test_hs_instantiated_modify\(column\).0/ write
      usage: wt [-LRrSVv] [-C config] [-E secretkey] [-h home] write [-ao] uri key ...
      

      We should be able to tell from the usage of the wt utility itself what these options -a and -o mean.

      For instance, wt verify usage can be expanded to:

      usage: wt [-LRrSVv] [-C config] [-E secretkey] [-h home] verify [-d dump_address | dump_blocks | dump_history | dump_layout | dump_offsets=#,# | dump_pages] [-s] -a|uri
      Verify options:
              -a      Verify the entire history store, not applicable against a URI
              -d      Dump more information while verifying the URI
              -s      Verify the URI against the stable timestamp, valid only after a rollback-to-stable
      

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              keith.bostic Keith Bostic
              Reporter:
              sulabh.mahajan Sulabh Mahajan
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: