This is an automated email from the ASF dual-hosted git repository. kmiller pushed a commit to branch develop in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push: new 2e1673b GEODE-5408 Update docs for gfsh remove --all (#2119) 2e1673b is described below commit 2e1673b3d347aea542416c736c9c3ab1359dc1ad Author: Karen Miller <karensmolermil...@users.noreply.github.com> AuthorDate: Wed Jul 11 13:42:34 2018 -0700 GEODE-5408 Update docs for gfsh remove --all (#2119) --- .../gfsh/command-pages/remove.html.md.erb | 30 ++++++++++++---------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/geode-docs/tools_modules/gfsh/command-pages/remove.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/remove.html.md.erb index 16e808b..a1c4a01 100644 --- a/geode-docs/tools_modules/gfsh/command-pages/remove.html.md.erb +++ b/geode-docs/tools_modules/gfsh/command-pages/remove.html.md.erb @@ -36,28 +36,32 @@ remove --region=value [--key=value] [--all(=value)?] [--key-class=value] | <span class="keyword parmname">\\-\\-key</span> | String or JSON text that will be used to create a key to retrieve a value . | | | <span class="keyword parmname">‑‑key‑class </span> | Fully qualified class name of the key's type. | key constraint for the current region or String | | <span class="keyword parmname">\\-\\-region</span> | *Required.* Region from which to remove the entry. | | -| <span class="keyword parmname">\\-\\-all</span> | Clears the region by removing all entries. | false | - -<span class="tablecap">Table 1. Remove Parameters</span> +| <span class="keyword parmname">\\-\\-all</span> | A boolean value that, when true, clears the region by removing all entries. This option is not available for partitioned regions. | false | **Example Commands:** ``` pre -gfsh>remove --region=/region1/region12 --key=('id': '133abg134') -gfsh>remove --region=/region1/region12 --key=('id': '133abg134') --key-class=data.ProfileKey -gfsh>remove --region=/region1/region12 --all +gfsh>remove --region=/region1 --key=('id': '133abg134') +gfsh>remove --region=/region1 --key=('id': '133abg134') --key-class=data.ProfileKey +gfsh>remove --region=/region1 --all=true ``` **Error Messages:** ``` pre -"Region name is either empty or Null"; -"Key is either empty or Null"; -"Value is either empty or Null"; -"Region <{0}> not found in any of the members"; -"Region <{0}> Not Found"; -"Key is not present in the region"; -"Cleared all keys in the region"; +"Region name is either empty or Null" + +"Key is either empty or Null" + +"Value is either empty or Null" + +"Region <{0}> not found in any of the members" + +"Region <{0}> Not Found" + +"Key is not present in the region" + +"Option --all is not supported on partitioned region" ```