Bug 814021 - [Doc]There is one typo "virsh list --note" in virsh list manual
[Doc]There is one typo "virsh list --note" in virsh list manual
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: libvirt (Show other bugs)
Unspecified Unspecified
low Severity low
: rc
: ---
Assigned To: Peter Krempa
Virtualization Bugs
Depends On:
  Show dependency treegraph
Reported: 2012-04-18 23:14 EDT by hongming
Modified: 2012-06-20 02:54 EDT (History)
9 users (show)

See Also:
Fixed In Version: libvirt-0.9.10-15.el6
Doc Type: Bug Fix
Doc Text:
No Documentation needed
Story Points: ---
Clone Of:
Last Closed: 2012-06-20 02:54:35 EDT
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description hongming 2012-04-18 23:14:18 EDT
Description of problem:
There is one typo "virsh list --note" in virsh list manual.

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

How reproducible:

Steps to Reproduce:
1.#man virsh

If --title is specified, then the domain note is printed. The output
then the output looks as follows. This flag is usable only with the
default --table output.

virsh list --note
Id Name State Title
0 Domain-0 running Mailserver 1
2 fedora paused

2.# virsh list --note
error: command 'list' doesn't support option --note

Actual results:
Command 'list' doesn't support option --note

Expected results:
"virsh list --note " be revised as "virsh list --title".

Additional info:
Comment 1 Alex Jia 2012-04-18 23:30:29 EDT
Patch for upstream:

commit c4c68b0025243eb7de39153ab97c1223f5e7ef7e
Author: Peter Krempa <pkrempa@redhat.com>
Date:   Tue Feb 21 15:05:49 2012 +0100

    virsh: Fix docs for list command
    Commit fad5cd210899dfde4afe36712754dc921c3f3051 introduced option to
    display domain's title in the list command output. There was a mistake
    in the virsh man page example for this command stating --note instead of
Comment 3 Peter Krempa 2012-04-19 04:43:58 EDT
Well, apart from that, the whole paragraph decribing the --title option sounds awkward. I'll post a patch to fix that.
Comment 4 Peter Krempa 2012-04-19 08:44:16 EDT
I clarified and made the paragraph above the example a little more understandable:

commit b83d76d40e1c5ffcbf6e1908fc86e4a650a1e9d3
Author: Peter Krempa <pkrempa@redhat.com>
Date:   Thu Apr 19 10:33:05 2012 +0200

    virsh: Fix and clarify the --title flag for the list command in man page
Comment 11 Huang Wenlong 2012-05-02 01:50:49 EDT
Verify this bug :

there is not "--note" in virsh manual 

#man virsh 

  list [--inactive | --all] [--managed-save] [--title] { [--table] | --name | --uuid } [--persistent] [--transient]
           Prints information about existing domains.  If no options are specified it prints out information about running domains.

# virsh help list
    list - list domains

    list [--inactive] [--all] [--transient] [--persistent] [--uuid] [--name] [--table] [--managed-save] [--title]

    Returns list of domains.

    --inactive       list inactive domains
    --all            list inactive & active domains
    --transient      list transient domains
    --persistent     list persistent domains
    --uuid           list uuid's only
    --name           list domain names only
    --table          list table (default)
    --managed-save   mark domains with managed save state
    --title          show short domain description
Comment 12 Peter Krempa 2012-05-02 05:48:49 EDT
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    New Contents:
No Documentation needed
Comment 14 errata-xmlrpc 2012-06-20 02:54:35 EDT
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.


Note You need to log in before you can comment on or make changes to this bug.