[GEODE-4645] gfsh help: Improve description of create region '--if-not-exists' option

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.4.0
• Fix Version/s: 1.5.0
• Component/s: gfsh
• Labels: pull-request-available
• Assignee: Unassigned
• Reporter: Dave Barnes
• Created: 09/Feb/18 18:08
• Updated: 09/Apr/18 22:36
• Resolved: 13/Feb/18 18:57

Description

The create region option `--if-not-exists` (formerly `--skip-if-exists`) is described as follows in the gfsh help:

  Skip region creation if the region already exists.

This is inaccurate, as `create region` never creates a duplicate region if one already exists. The option merely de-escalates the response level from "throw an error and stop" to "print an informational message and continue."

Here's a suggested replacement for the help message based on the User Guide (edit as you see fit):

  By default, an attempt to create a duplicate region is reported as an error. If this option is specified without a value or is specified with a value of `true`, then gfsh displays a "Skipping..." acknowledgement, but does not throw an error.

Issue Links

• links to: GitHub Pull Request #1431