Uploaded image for project: 'MongoDB Database Tools'
  1. MongoDB Database Tools
  2. TOOLS-1806

Don't include default values in option descriptions since they are echoed by default

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • Minor - P4
    • Resolution: Fixed
    • 3.4.9
    • 4.2.1, 4.3.1
    • All Tools

    Description

      Some tool options include default values in their descriptions which are also echoed by default, leading to duplication and possible confusion.

      For example:

      $ mongoexport --help | grep -i default
            --gssapiServiceName=<service-name>          service name to use when authenticating using GSSAPI/Kerberos ('mongodb' by default)
            --gssapiHostName=<host-name>                hostname to use when authenticating using GSSAPI/Kerberos (remote server's address by default)
            --type=<type>                               the output format, either json or csv (defaults to 'json') (default: json)
        -k, --slaveOk                                   allow secondary reads if available (default true) (default: false)
            --assertExists                              if specified, export fails if the collection does not exist (default: false)
      

      Attachments

        Issue Links

          Activity

            People

              tim.fogarty@mongodb.com Tim Fogarty
              stephen.steneker@mongodb.com Stennie Steneker
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: