From b8a0b631dcaa485cc9468bb7335d687a2adfb761 Mon Sep 17 00:00:00 2001 From: John Ferlan Date: Tue, 12 Feb 2013 12:48:46 -0500 Subject: [PATCH] api: Reword objects exposed section --- docs/api.html.in | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/docs/api.html.in b/docs/api.html.in index f596aa9fdd..0f01aed86e 100644 --- a/docs/api.html.in +++ b/docs/api.html.in @@ -8,26 +8,28 @@ -

Objects exposed

-

As defined in the goals section, libvirt - API need to expose all the resources needed to manage the virtualization - support of recent operating systems. The first object manipulated though - the API is virConnectPtr which represent a connection to - an hypervisor. Any application using libvirt is likely to start using the +

Objects Exposed

+

As defined in the goals section, the libvirt + API is designed to expose all the resources needed to manage the + virtualization support of recent operating systems. The first object + manipulated through the API is the virConnectPtr, which + represents the connection to a hypervisor. Any application using libvirt + is likely to start using the API by calling one of the virConnectOpen functions. You will note that those functions take - a name argument which is actually an URI to select the right hypervisor to - open, this is needed to allow remote connections and also select between - different possible hypervisors (for example on a Linux system it may be - possible to use both KVM and LinuxContainers on the same node). A NULL - name will default to a preselected hypervisor but it's probably not a + a name argument which is actually a connection URI + to select the right hypervisor to open. + A URI is needed to allow remote connections and also select between + different possible hypervisors. For example, on a Linux system it may be + possible to use both KVM and LinuxContainers on the same node. A NULL + name will default to a preselected hypervisor, but it's probably not a wise thing to do in most cases. See the connection URI page for a full descriptions of the values allowed.

-

Once the application obtained a virConnectPtr - connection to the - hypervisor it can then use it to manage domains and related resources - available for virtualization like storage and networking. All those are - exposed as first class objects, and connected to the hypervisor connection +

Once the application obtains a virConnectPtr + connection to the hypervisor it can then use it to manage the hypervisor's + available domains and related virtualization + resources, such as storage and networking. All those are + exposed as first class objects and connected to the hypervisor connection (and the node or cluster where it is available).