Bug 655740 - Reference documentation needed for virsh commands
Summary: Reference documentation needed for virsh commands
Alias: None
Product: Virtualization Tools
Classification: Community
Component: libvirt-virshcmdref
Version: unspecified
Hardware: Unspecified
OS: Unspecified
Target Milestone: ---
Assignee: Libvirt Maintainers
QA Contact:
Depends On:
TreeView+ depends on / blocked
Reported: 2010-11-22 10:57 UTC by Justin Clift
Modified: 2016-03-23 16:39 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Last Closed: 2016-03-23 16:39:59 UTC

Attachments (Terms of Use)

Description Justin Clift 2010-11-22 10:57:22 UTC
We urgently need the virsh commands documented, in order to provide adequate reference material for customers and the wider libvirt Community.

Eric, as you're the author of these virsh commands or know them pretty well, are you ok to write the reference documentation for them?

 + echo
 + exit
 + quit
 + maxvcpus
 + setvcpus
 + vcpucount

We're using a fairly simple reference layout, as seen online here:


 a) A short description of what the command does

    Multi-line if appropriate.  It's generally assumed the reader
    will already know the required concepts involved, so won't
    need to have instruction of concepts here.

 b) Usage.  The command line arguments/options

    + Description of each of the arguments.
    + Is each one optional or mandatory?, plus a short description

c) Simple examples of usage command line usage

   Without context, purely to show what the arguments on the
   command line look like when used.

d) Examples in context

   A more in depth example of the command, to mentally convey real
   world usage.

If this task is better done by someone else, please feel free to re-assign. :)

Comment 2 Cole Robinson 2016-03-23 16:39:59 UTC
These bugs really don't serve any purpose... virshcmdref has had one commit in 4.5 years. Any attempt at reviving it is going to need an up to date look at current virsh state. These bugs are not going to help

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