Bug 1490164

Summary: OPTIONS "[--domain] <string>" should not include "id" in "virsh domrename --help"
Product: Red Hat Enterprise Linux 7 Reporter: Yanqiu Zhang <yanqzhan>
Component: libvirtAssignee: Libvirt Maintainers <libvirt-maint>
Status: CLOSED NOTABUG QA Contact: Virtualization Bugs <virt-bugs>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.5CC: dyuan, eskultet, fjin, mzhan, rbalakri, xuzhang, yanqzhan
Target Milestone: rc   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-09-11 08:55:34 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:
Embargoed:

Description Yanqiu Zhang 2017-09-11 02:38:14 UTC
Description of problem:
"domrename" is used to rename an inactive domain, so it's "[--domain] <string>" should be "domain name or uuid", not to include "id".

Version-Release number of selected component (if applicable):
libvirt-3.7.0-2.el7.x86_64

How reproducible:
100%

Steps to Reproduce:
1. # virsh domrename --help
  NAME
    domrename - rename a domain

  SYNOPSIS
    domrename <domain> <new-name>

  DESCRIPTION
    Rename an inactive domain.

  OPTIONS
    [--domain] <string>  domain name, id or uuid <==include "id"
    [--new-name] <string>  new domain name


Actual results:
OPTIONS "[--domain] <string>" is "domain name, id or uuid"

Expected results:
OPTIONS "[--domain] <string>" should be "domain name or uuid"

Additional info:

Comment 2 Erik Skultety 2017-09-11 08:55:34 UTC
Imagine libvirtd implemented it for running guests as well. You grab the newest virsh client that documents that rename can be used for running guests as well and then you connect it to an old daemon that doesn't implement that feature yet. The help string wouldn't reflect the reality either. So, you can clearly see that this is not client-dependent (even though the current daemon doesn't implement it).