Bug 1004649

Summary: Need description information for "oo-devel-node connector-execute" in help content.
Product: OpenShift Online Reporter: Qiushui Zhang <qiuzhang>
Component: ContainersAssignee: Paul Morie <pmorie>
Status: CLOSED CURRENTRELEASE QA Contact: libra bugs <libra-bugs>
Severity: low Docs Contact:
Priority: medium    
Version: 2.xCC: pmorie, xtian
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-01-30 00:48:35 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Qiushui Zhang 2013-09-05 07:00:29 UTC
Description of problem:
No description in the help content of "oo-devel-node connector-execute"


Version-Release number of selected component (if applicable):
devenv_3745

How reproducible:
always

Steps to Reproduce:
1. On instance, run command "oo-devel-node --help connector-execute"
2.
3.

Actual results:
[root@ip-10-62-121-48 ~]# oo-devel-node --help connector-execute

  NAME:

    connector-execute

  DESCRIPTION:

    Need better documentation

  SYNOPSIS:

    oo-devel-node connector-execute --with-container-uuid UUID --cartridge-name NAME \
     --publishing-cartridge-name NAME --hook-name NAME --connection-type TYPE --input-args ARGS

  OPTIONS:
	
    -N, --cartridge-name NAME 
        Unique identifier for the cartridge that the component belongs to
	
    --publishing-cartridge-name NAME 
        
	
    --hook-name NAME 
        Name of the connector to be executed
	
    -T, --connection-type TYPE 
        
	
    --input-args ARGS 
        k1=v1\nk2=v2\n


Expected results:
The "DESCRIPTION" should describe the command function clearly, instead of "Need better documentation"

Additional info:

Comment 2 Qiushui Zhang 2013-11-06 07:44:46 UTC
Tested on devenv_3993.

[root@ip-10-60-155-14 ~]# oo-devel-node --help connector-execute

  NAME:

    connector-execute

  DESCRIPTION:

    Run a specific connection hook in the application

  SYNOPSIS:

    oo-devel-node connector-execute --with-container-uuid UUID --cartridge-name NAME \
     --publishing-cartridge-name NAME --hook-name NAME --connection-type TYPE --input-args ARGS

  OPTIONS:
	
    -N, --cartridge-name NAME 
        Unique identifier for the cartridge that the component belongs to
	
    --publishing-cartridge-name NAME 
        
	
    --hook-name NAME 
        Name of the connector to be executed
	
    -T, --connection-type TYPE 
        
	
    --input-args ARGS 
        k1=v1\nk2=v2\n
	
The help content is updated.

Mark the bug as verified.