[libvirt] Libvirt guide draft published on libvirt.org

Gerhard Stenzel gstenzel at linux.vnet.ibm.com
Thu Jan 28 14:06:33 UTC 2010


On Mon, 2010-01-18 at 20:00 -0500, David Jorm wrote:
> I am a tech writer who recently joined the Red Hat team. I have been tasked with assisting in the improvement of libvirt documentation where possible and co-ordinating the development of the libvirt Application Development Guide. The guide was previously in the hands of Dani Coulson, who has since left Red Hat. She got it to a draft stage with a skeletal structure, but as far as I can tell nothing ever reached a publishable state. I've picked up where she left off and re-built the latest guide from the DocBook XML in git. It is now up at:
> 
> http://libvirt.org/guide/
> 
> If you look in the guide, you will notice an awful lot of "TBD" stubs. Contributions to fill these would be greatly appreciated - please email them to me directly. I will chase up with the people who were originally nominated as the responsible parties to try and get some content to flesh out the guide.
> 
> I don't have a lot of spare temporal bandwidth at the moment, but if there are any docs-related BZs or libvirt issues, feel free to push them my way and i'll do what I can. I think i've made every mistake possible so far in submitting patches, so I know the process by virtue of what-not-to-do.
> 
> Thanks
> David
> 
> --
> libvir-list mailing list
> libvir-list at redhat.com
> https://www.redhat.com/mailman/listinfo/libvir-list

A few minor spelling problems which I noticed:


diff --git a/en-US/Network_Interfaces.xml b/en-US/Network_Interfaces.xml
index c307dc6..cc45cf0 100644
--- a/en-US/Network_Interfaces.xml
+++ b/en-US/Network_Interfaces.xml
@@ -14,7 +14,7 @@
     <para>
       The configuration of network interfaces on physical hosts can be
       examined and modified with functions in the virInterface API.
This is
-      useful for setting up the host to share one physical interface
bewteen
+      useful for setting up the host to share one physical interface
between
       multiple guest domains you want connected directly to the network
       (briefly - enslave a physical interface to the bridge, then
create a
       tap device for each VM you want to share the interface), as well
as
@@ -332,7 +332,7 @@ free(xml);]]>
     </para>
 
     <section
id="Application_Development_Guide-Network_Interfaces-Configs-Define">
-      <title>Defining an inteface configuration</title>
+      <title>Defining an interface configuration</title>
       <para>
        The virInterfaceDefineXML function is used both for adding new
interface configurations
        and modifying existing configurations. It either adds a new
interface
@@ -382,7 +382,7 @@ cleanup:
     </section>
 
     <section
id="Application_Development_Guide-Network_Interfaces-Configs-Undefine">
-      <title>Undefining an inteface configuration</title>
+      <title>Undefining an interface configuration</title>
       <para>
        virInterfaceUndefine completely and permanently removes the
        configuration for the given interface from tho host's
configuration
@@ -442,7 +442,7 @@ if (!iface) {
       <para>
        virInterfaceDestroy makes the given interface inactive ("down").
On
        success, it returns 0. If there is any problem making the
interface
-       acrive, -1 is returned.
+       active, -1 is returned.
       </para>
 
       <example>

-- 
Best regards, 

Gerhard Stenzel, 
-----------------------------------------------------------------------------------------------------------------------------------
IBM Deutschland Research & Development GmbH
Vorsitzender des Aufsichtsrats: Martin Jetter
Geschäftsführung: Dirk Wittkopp
Sitz der Gesellschaft: Böblingen
Registergericht: Amtsgericht Stuttgart, HRB 243294




More information about the libvir-list mailing list