[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCH] Minor doc tweaks



Per subject; clarifies the distinction between virDomainCreateLinux and virDomainDefineXML+virDomainCreate, and adds documentation for the autoport display attribute.
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 70b9c4a..7177965 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -584,8 +584,10 @@
       <dd>The <code>graphics</code> element has a mandatory <code>type</code>
 	attribute which takes the value "sdl" or "vnc". The former displays
 	a window on the host desktop, while the latter activates a VNC server.
-	If the latter is used the <code>port</code> attributes specifies the
-	TCP port number (with -1 indicating that it should be auto-allocated).
+	If the latter is used the <code>port</code> attribute specifies the TCP
+	port number (with -1 as legacy syntax indicating that it should be
+	auto-allocated). The <code>autoport</code> attribute is the new
+	preferred syntax for indicating autoallocation of the TCP port to use.
 	The <code>listen</code> attribute is an IP address for the server to
 	listen on. The <code>password</code> attribute provides a VNC password
 	in clear text.</dd>
diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index 136ba0d..7b70280 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -854,14 +854,14 @@ see note above'/>
       <arg name='domain' type='virDomainPtr' info='pointer to a defined domain'/>
     </function>
     <function name='virDomainCreateLinux' file='libvirt' module='libvirt'>
-      <info>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</info>
+      <info>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc(). This function may requires privileged access to the hypervisor. The domain is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted.</info>
       <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
       <arg name='xmlDesc' type='const char *' info='string containing an XML description of the domain'/>
       <arg name='flags' type='unsigned int' info='an optional set of virDomainFlags'/>
     </function>
     <function name='virDomainDefineXML' file='libvirt' module='libvirt'>
-      <info>define a domain, but does not start it</info>
+      <info>Define a domain, but does not start it. This definition is persistent, until explicitly undefined.</info>
       <return type='virDomainPtr' info='NULL in case of error, a pointer to the domain otherwise'/>
       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
       <arg name='xml' type='const char *' info='the XML description for the domain, preferably in UTF-8'/>

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]