Bug 1632601 - Inconsistency in help menu of virtctl
Summary: Inconsistency in help menu of virtctl
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: User Experience
Version: 1.1
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 1.3
Assignee: Tomas Jelinek
QA Contact: Guohua Ouyang
URL:
Whiteboard:
Depends On:
Blocks: 1648436 1648442
TreeView+ depends on / blocked
 
Reported: 2018-09-25 08:23 UTC by Irina Gulina
Modified: 2019-01-15 14:07 UTC (History)
7 users (show)

Fixed In Version: 1.3
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
: 1648436 (view as bug list)
Environment:
Last Closed: 2019-01-15 14:07:37 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)

Description Irina Gulina 2018-09-25 08:23:57 UTC 
Description of problem:
replace "VirtualMachine" with "virtual machine" in help menu of virtctl for stop command. And add dots in the end of sentences where they are missing.

$ virtctl 
Available Commands:
  console     Connect to a console of a virtual machine instance.
  expose      Expose a virtual machine instance, virtual machine, or virtual machine instance replica set as a new service.
  help        Help about any command
  start       Start a virtual machine.
  stop        Stop a VirtualMachine.
  version     Print the client and server version information
  vnc         Open a vnc connection to a virtual machine instance.

Use "virtctl <command> --help" for more information about a given command.
Use "virtctl options" for a list of global command-line options (applies to all commands).

$ virtctl  version
Client Version: version.Info{GitVersion:"v0.8.0", GitCommit:"6165ead7201d8b96946fdfcfb026e44b86d3d980", GitTreeState:"clean", BuildDate:"2018-09-16T09:21:34Z", GoVersion:"go1.9.4", Compiler:"gc", Platform:"linux/amd64"}
Server Version: &version.Info{GitVersion:"v1.2.0-5-2-g7d06705", GitCommit:"6165ead7201d8b96946fdfcfb026e44b86d3d980", GitTreeState:"clean", BuildDate:"2018-09-12T13:49:04Z", GoVersion:"go1.9.4", Compiler:"gc", Platform:"linux/amd64"}

That comes from BZ #1613726
Comment 1 Guohua Ouyang 2018-09-25 11:45:11 UTC 
Send pr https://github.com/kubevirt/kubevirt/pull/1545 to fix this.
Comment 2 Guohua Ouyang 2018-11-08 11:36:14 UTC 
It looks good in 1.3 now.

$ virtctl -h
virtctl controls virtual machine related operations on your kubernetes cluster.

Available Commands:
  console     Connect to a console of a virtual machine instance.
  expose      Expose a virtual machine instance, virtual machine, or virtual machine instance replica set as a new service.
  help        Help about any command
  start       Start a virtual machine.
  stop        Stop a virtual machine.
  version     Print the client and server version information.
  vnc         Open a vnc connection to a virtual machine instance.

Use "virtctl <command> --help" for more information about a given command.
Use "virtctl options" for a list of global command-line options (applies to all commands).

$ virtctl help stop
Stop a virtual machine.

Usage:
  virtctl stop (VM) [flags]

Examples:
  # Stop a virtual machine called 'myvm':
  virtctl stop myvm

Flags:
  -h, --help   help for stop

Use "virtctl options" for a list of global command-line options (applies to all commands).
[cloud-user@cnv-executor-guohua-master1 ~]$ virtctl help start
Start a virtual machine.

Usage:
  virtctl start (VM) [flags]

Examples:
  # Start a virtual machine called 'myvm':
  virtctl start myvm

Flags:
  -h, --help   help for start

Use "virtctl options" for a list of global command-line options (applies to all commands).
Note You need to log in before you can comment on or make changes to this bug.