[
https://issues.apache.org/jira/browse/GEODE-5051?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Karen Smoler Miller updated GEODE-5051:
---------------------------------------
Description:
The current help text output for gfsh destroy jndi-binding contains some errors:
gfsh>help destroy jndi-binding
NAME
destroy jndi-binding
IS AVAILABLE
false
SYNOPSIS
Destroy a jndi binding that holds the configuration for the XA datasource.
SYNTAX
destroy jndi-binding --name=value [--if-exists(=value)?]
PARAMETERS
name
Name of the binding to be destroyed.
Required: true
if-exists
Skip the destroy operation when a jndi binding with the same name does
not exists. Without specifying this option, this command execution
results into an error.
Required: false
Default (if the parameter is specified without value): true
Default (if the parameter is not specified): false
We can improve this text by changing the underlined prose to:
gfsh>help destroy jndi-binding
NAME
destroy jndi-binding
IS AVAILABLE
false
SYNOPSIS
Destroy a +JNDI+ binding that holds the configuration for +an+ XA
datasource.
SYNTAX
destroy jndi-binding --name=value [--if-exists(=value)?]
PARAMETERS
name
Name of the binding to be destroyed.
Required: true
if-exists
+Skip the destroy operation when the specified JNDI binding does+
+not exist. Without this option, an error results from the
specification+
+of a JNDI binding that does not exist.+
Required: false
Default (if the parameter is specified without value): true
Default (if the parameter is not specified): false
was:
The current help text output for gfsh destroy jndi-binding contains some errors:
gfsh>help destroy jndi-binding
NAME
destroy jndi-binding
IS AVAILABLE
false
SYNOPSIS
Destroy a jndi binding that holds the configuration for the XA datasource.
SYNTAX
destroy jndi-binding --name=value [--if-exists(=value)?]
PARAMETERS
name
Name of the binding to be destroyed.
Required: true
if-exists
Skip the destroy operation when a jndi binding with the same name does
not exists. Without specifying this option, this command execution
results into an error.
Required: false
Default (if the parameter is specified without value): true
Default (if the parameter is not specified): false
We can improve this text by changing the underlined prose to:
gfsh>help destroy jndi-binding
NAME
destroy jndi-binding
IS AVAILABLE
false
SYNOPSIS
Destroy a +JNDI+ binding that holds the configuration for +an+ XA
datasource.
SYNTAX
destroy jndi-binding --name=value [--if-exists(=value)?]
PARAMETERS
name
Name of the binding to be destroyed.
Required: true
if-exists
+Skip the destroy operation when the specified JNDI binding does
not exist. Without this option, an error results from the specification
of a JNDI binding that does not exist.+
Required: false
Default (if the parameter is specified without value): true
Default (if the parameter is not specified): false
> Improve gfsh destroy jndi-binding help prose
> --------------------------------------------
>
> Key: GEODE-5051
> URL: https://issues.apache.org/jira/browse/GEODE-5051
> Project: Geode
> Issue Type: Improvement
> Components: gfsh
> Reporter: Karen Smoler Miller
> Priority: Major
>
> The current help text output for gfsh destroy jndi-binding contains some
> errors:
> gfsh>help destroy jndi-binding
> NAME
> destroy jndi-binding
> IS AVAILABLE
> false
> SYNOPSIS
> Destroy a jndi binding that holds the configuration for the XA datasource.
> SYNTAX
> destroy jndi-binding --name=value [--if-exists(=value)?]
> PARAMETERS
> name
> Name of the binding to be destroyed.
> Required: true
> if-exists
> Skip the destroy operation when a jndi binding with the same name does
> not exists. Without specifying this option, this command execution
> results into an error.
> Required: false
> Default (if the parameter is specified without value): true
> Default (if the parameter is not specified): false
> We can improve this text by changing the underlined prose to:
> gfsh>help destroy jndi-binding
> NAME
> destroy jndi-binding
> IS AVAILABLE
> false
> SYNOPSIS
> Destroy a +JNDI+ binding that holds the configuration for +an+ XA
> datasource.
> SYNTAX
> destroy jndi-binding --name=value [--if-exists(=value)?]
> PARAMETERS
> name
> Name of the binding to be destroyed.
> Required: true
> if-exists
> +Skip the destroy operation when the specified JNDI binding does+
> +not exist. Without this option, an error results from the
> specification+
> +of a JNDI binding that does not exist.+
> Required: false
> Default (if the parameter is specified without value): true
> Default (if the parameter is not specified): false
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
