Bug 655740

Summary: Reference documentation needed for virsh commands
Product: [Community] Virtualization Tools Reporter: Justin Clift <jclift>
Component: libvirt-virshcmdrefAssignee: Libvirt Maintainers <libvirt-maint>
Status: CLOSED DEFERRED QA Contact:
Severity: high Docs Contact:
Priority: low    
Version: unspecifiedCC: crobinso, eblake, kwade, xen-maint
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: 2016-03-23 16:39:59 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

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:

 http://libvirt.org/sources/virshcmdref/html/sect-net-create.html

 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