Re: [libvirt] [PATCH] virsh: improve documentation

Document several missing commands.  There's more work that could be done, but incremental improvements is better than no patch at all. * tools/virsh.pod (autostart, connect): Improve grammar. (create): Improve example. (domjobabort, domjobinfo, domxml-from-native, domxml-to-native): Document. (storage pool commands): New section. ---  tools/virsh.pod |  167 ++++++++++++++++++++++++++++++++++++++++++++++++++----  1 files changed, 154 insertions(+), 13 deletions(-)

@@ -260,11 +262,15 @@ Connect the virtual serial console for the guest.  =item B<create> I<FILE> -Create a domain from an XML <file>. An easy way to create the XML <file> is to use the B<dumpxml> command to obtain the definition of a pre-existing guest. +Create a domain from an XML <file>. An easy way to create the XML +<file> is to use the B<dumpxml> command to obtain the definition of a +pre-existing guest.  B<Example> -virsh dumpxml <domain-id> > file. +virsh dumpxml <domain-id> >

+edit file +virsh create < file

@@ -566,7 +591,7 @@ Edit the XML configuration file for a network.  This is equivalent to:  virsh net-dumpxml network > network.xml  edit network.xml - virsh define network.xml + virsh net-define network.xml  except that it does some error checking.

+ +=item B<pool-delete> I<pool-or-uuid> + +Destroy the resources used by a given I<pool> object. This operation +is non-recoverable.  The I<pool> object will still exist after this +command. + +=item B<pool-dumpxml> I<pool-or-uuid> + +Returns the XML information about the I<pool> object. + +=item B<pool-edit> I<pool-or-uuid> + +Edit the XML configuration file for a storage pool. + +This is equivalent to: + virsh pool-dumpxml pool > pool.xml + edit pool.xml + virsh pool-define pool.xml +except that it does some error checking.