* docs/apibuild.py docs/newapi.xsl: fix generation of XML and

stylesheet * docs/*: regenerated * src/bridge.c src/bridge.h src/buf.c src/iptables.c src/libvirt.c src/qemu_driver.c src/qemu_driver.h src/uuid.c src/uuid.h: cleanup, addd comments, made functions static and fixe a few bugs Daniel
2026-08-04 10:23:02 -05:00 · 2007-06-29 13:23:13 +00:00
parent 4c0f24c10f
commit b4c282a79b
20 changed files with 597 additions and 198 deletions
@@ -125,10 +125,12 @@
 <a href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a><br />
 <a href="html/libvirt-libvirt.html#virConnectNumOfNetworks">virConnectNumOfNetworks</a><br />
 <a href="html/libvirt-libvirt.html#virDomainGetAutostart">virDomainGetAutostart</a><br />
+<a href="html/libvirt-libvirt.html#virDomainGetConnect">virDomainGetConnect</a><br />
 <a href="html/libvirt-libvirt.html#virDomainGetMaxVcpus">virDomainGetMaxVcpus</a><br />
 <a href="html/libvirt-libvirt.html#virGetVersion">virGetVersion</a><br />
 <a href="html/libvirt-libvirt.html#virNetworkGetAutostart">virNetworkGetAutostart</a><br />
 <a href="html/libvirt-libvirt.html#virNetworkGetBridgeName">virNetworkGetBridgeName</a><br />
+<a href="html/libvirt-libvirt.html#virNetworkGetConnect">virNetworkGetConnect</a><br />
 </dd></dl><h2>Letter R:</h2><dl><dt>RFC4122</dt><dd><a href="html/libvirt-libvirt.html#virDomainGetUUIDString">virDomainGetUUIDString</a><br />
 <a href="html/libvirt-libvirt.html#virNetworkGetUUIDString">virNetworkGetUUIDString</a><br />
 </dd><dt>Read-Only</dt><dd><a href="html/libvirt-libvirt.html#virConnectGetVersion">virConnectGetVersion</a><br />
@@ -138,8 +140,6 @@
 <a href="html/libvirt-virterror.html#virResetLastError">virResetLastError</a><br />
 </dd><dt>Resume</dt><dd><a href="html/libvirt-libvirt.html#virDomainResume">virDomainResume</a><br />
 </dd><dt>Retrieve</dt><dd><a href="html/libvirt-libvirt.html#virDomainGetMaxMemory">virDomainGetMaxMemory</a><br />
-</dd><dt>Returns</dt><dd><a href="html/libvirt-libvirt.html#virDomainGetConnect">virDomainGetConnect</a><br />
-<a href="html/libvirt-libvirt.html#virNetworkGetConnect">virNetworkGetConnect</a><br />
 </dd></dl><h2>Letter S:</h2><dl><dt>See</dt><dd><a href="html/libvirt-libvirt.html#virConnectGetType">virConnectGetType</a><br />
 </dd><dt>Set</dt><dd><a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a><br />
 <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a><br />
@@ -51,6 +51,17 @@ ignored_files = {
  "console.c": "internal code",
  "event.h": "internal code",
  "event.c": "internal code",
+  "iptables.h": "internal code",
+  "iptables.c": "internal code",
+  "buf.h": "internal code",
+  "buf.c": "internal code",
+  "qemu_driver.c": "internal code",
+  "remote_internal.c": "internal code",
+  "bridge.h": "internal code",
+  "bridge.c": "internal code",
+  "uuid.h": "internal code",
+  "uuid.c": "internal code",
+
 }

 ignored_words = {
@@ -442,8 +442,8 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div></div>
        <hr/>
        <div class="refsect2" lang="en"><h3><a name="virDomainGetConnect"/>virDomainGetConnect ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virDomainGetConnect	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)<br/>
-</pre><p/>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to a domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the connection pointer associated with a domain. The reference counter on the connection is not increased by this call. Returns the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div></div>
+</pre><p>Provides the connection pointer associated with a domain. The reference counter on the connection is not increased by this call.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to a domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div></div>
        <hr/>
        <div class="refsect2" lang="en"><h3><a name="virDomainGetID"/>virDomainGetID ()</h3><pre class="programlisting">unsigned int	virDomainGetID		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br/>
 </pre><p>Get the hypervisor ID number for the domain</p>
@@ -598,8 +598,8 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div></div>
        <hr/>
        <div class="refsect2" lang="en"><h3><a name="virNetworkGetConnect"/>virNetworkGetConnect ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virNetworkGetConnect	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)<br/>
-</pre><p/>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>net</tt></i>:</span></td><td>pointer to a network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the connection pointer associated with a network. The reference counter on the connection is not increased by this call. Returns the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div></div>
+</pre><p>Provides the connection pointer associated with a network. The reference counter on the connection is not increased by this call.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>net</tt></i>:</span></td><td>pointer to a network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div></div>
        <hr/>
        <div class="refsect2" lang="en"><h3><a name="virNetworkGetName"/>virNetworkGetName ()</h3><pre class="programlisting">const char *	virNetworkGetName	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br/>
 </pre><p>Get the public name for that network</p>
@@ -3,5 +3,5 @@ Makefile.in
 Makefile
 .deps
 .libs
-info1
 suspend
+info1
@@ -18,24 +18,24 @@ install-data-local:

 EXTRA_DIST=examples.xsl index.py examples.xml 

-noinst_PROGRAMS=info1 suspend 
-
-info1_SOURCES=info1.c
-info1_LDFLAGS=
-info1_DEPENDENCIES= $(DEPS)
-info1_LDADD= $(LDADDS)
+noinst_PROGRAMS=suspend info1 

 suspend_SOURCES=suspend.c
 suspend_LDFLAGS=
 suspend_DEPENDENCIES= $(DEPS)
 suspend_LDADD= $(LDADDS)

+info1_SOURCES=info1.c
+info1_LDFLAGS=
+info1_DEPENDENCIES= $(DEPS)
+info1_LDADD= $(LDADDS)
+
 valgrind: 
 	$(MAKE) CHECKER='valgrind' tests

 tests: $(noinst_PROGRAMS)
 	@(echo '## examples regression tests')
-	@($(CHECKER) ./info1)
 	@($(CHECKER) ./suspend)
+	@($(CHECKER) ./info1)


@@ -1,23 +1,4 @@
 <examples>
-  <example filename='info1.c'>
-    <synopsis>Extract informations about Xen domain 0</synopsis>
-    <purpose>Demonstrate the basic use of the library to connect to the hypervisor and extract domain informations.</purpose>
-    <usage>info1</usage>
-    <test>info1</test>
-    <author>Daniel Veillard</author>
-    <copy>see Copyright for the status of this software. </copy>
-    <section>Informations</section>
-    <includes>
-    </includes>
-    <uses>
-      <function line='43' file='libvirt' name='virDomainGetInfo'/>
-      <function line='53' file='libvirt' name='virDomainFree'/>
-      <function line='36' file='libvirt' name='virDomainLookupByID'/>
-      <function line='55' file='libvirt' name='virConnectClose'/>
-      <struct line='25' file='libvirt' name='virDomainInfo'/>
-      <function line='29' file='libvirt' name='virConnectOpenReadOnly'/>
-    </uses>
-  </example>
  <example filename='suspend.c'>
    <synopsis>Suspend a domain and then resume its execution</synopsis>
    <purpose>Demonstrate the basic use of the library to suspend and resume a domain. If no id is given on the command line this script will suspend and resume the first domain found which is not Domain 0.</purpose>
@@ -40,33 +21,52 @@
      <function line='100' file='libvirt' name='virConnectOpenReadOnly'/>
    </uses>
  </example>
+  <example filename='info1.c'>
+    <synopsis>Extract informations about Xen domain 0</synopsis>
+    <purpose>Demonstrate the basic use of the library to connect to the hypervisor and extract domain informations.</purpose>
+    <usage>info1</usage>
+    <test>info1</test>
+    <author>Daniel Veillard</author>
+    <copy>see Copyright for the status of this software. </copy>
+    <section>Informations</section>
+    <includes>
+    </includes>
+    <uses>
+      <function line='43' file='libvirt' name='virDomainGetInfo'/>
+      <function line='53' file='libvirt' name='virDomainFree'/>
+      <function line='36' file='libvirt' name='virDomainLookupByID'/>
+      <function line='55' file='libvirt' name='virConnectClose'/>
+      <struct line='25' file='libvirt' name='virDomainInfo'/>
+      <function line='29' file='libvirt' name='virConnectOpenReadOnly'/>
+    </uses>
+  </example>
  <symbols>
    <symbol name='virConnectClose'>
-      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
+      <ref filename='info1.c'/>
    </symbol>
    <symbol name='virConnectListDomains'>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virConnectOpenReadOnly'>
-      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
+      <ref filename='info1.c'/>
    </symbol>
    <symbol name='virDomainFree'>
-      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
+      <ref filename='info1.c'/>
    </symbol>
    <symbol name='virDomainGetInfo'>
-      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
+      <ref filename='info1.c'/>
    </symbol>
    <symbol name='virDomainInfo'>
-      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
+      <ref filename='info1.c'/>
    </symbol>
    <symbol name='virDomainLookupByID'>
-      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
+      <ref filename='info1.c'/>
    </symbol>
    <symbol name='virDomainResume'>
      <ref filename='suspend.c'/>
@@ -242,8 +242,8 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetAutostart" id="virDomainGetAutostart"></a>Function: virDomainGetAutostart</h3><pre class="programlisting">int	virDomainGetAutostart		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * autostart)<br />
 </pre><p>Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.</p>
 <div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetConnect" id="virDomainGetConnect"></a>Function: virDomainGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virDomainGetConnect	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)<br />
-</pre><p></p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to a domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the connection pointer associated with a domain. The reference counter on the connection is not increased by this call. Returns the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetID" id="virDomainGetID"></a>Function: virDomainGetID</h3><pre class="programlisting">unsigned int	virDomainGetID		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Provides the connection pointer associated with a domain. The reference counter on the connection is not increased by this call.</p>
+<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to a domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetID" id="virDomainGetID"></a>Function: virDomainGetID</h3><pre class="programlisting">unsigned int	virDomainGetID		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
 </pre><p>Get the hypervisor ID number for the domain</p>
 <div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the domain ID number or (unsigned int) -1 in case of error</td></tr></tbody></table></div><h3><a name="virDomainGetInfo" id="virDomainGetInfo"></a>Function: virDomainGetInfo</h3><pre class="programlisting">int	virDomainGetInfo		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info)<br />
 </pre><p>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</p>
@@ -320,8 +320,8 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetBridgeName" id="virNetworkGetBridgeName"></a>Function: virNetworkGetBridgeName</h3><pre class="programlisting">char *	virNetworkGetBridgeName		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
 </pre><p>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</p>
 <div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virNetworkGetConnect" id="virNetworkGetConnect"></a>Function: virNetworkGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virNetworkGetConnect	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)<br />
-</pre><p></p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>net</tt></i>:</span></td><td>pointer to a network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the connection pointer associated with a network. The reference counter on the connection is not increased by this call. Returns the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkGetName" id="virNetworkGetName"></a>Function: virNetworkGetName</h3><pre class="programlisting">const char *	virNetworkGetName	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Provides the connection pointer associated with a network. The reference counter on the connection is not increased by this call.</p>
+<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>net</tt></i>:</span></td><td>pointer to a network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkGetName" id="virNetworkGetName"></a>Function: virNetworkGetName</h3><pre class="programlisting">const char *	virNetworkGetName	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
 </pre><p>Get the public name for that network</p>
 <div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the network object.</td></tr></tbody></table></div><h3><a name="virNetworkGetUUID" id="virNetworkGetUUID"></a>Function: virNetworkGetUUID</h3><pre class="programlisting">int	virNetworkGetUUID		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 unsigned char * uuid)<br />
 </pre><p>Get the UUID for a network</p>
@@ -614,8 +614,8 @@
      <arg name='autostart' type='int *' info='the value returned'/>
    </function>
    <function name='virDomainGetConnect' file='libvirt' module='libvirt'>
-      <info></info>
-      <return type='virConnectPtr' info='the connection pointer associated with a domain.  The reference counter on the connection is not increased by this call.  Returns the virConnectPtr or NULL in case of failure.'/>
+      <info>Provides the connection pointer associated with a domain.  The reference counter on the connection is not increased by this call.</info>
+      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
      <arg name='dom' type='virDomainPtr' info='pointer to a domain'/>
    </function>
    <function name='virDomainGetID' file='libvirt' module='libvirt'>
@@ -850,8 +850,8 @@
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
    <function name='virNetworkGetConnect' file='libvirt' module='libvirt'>
-      <info></info>
-      <return type='virConnectPtr' info='the connection pointer associated with a network.  The reference counter on the connection is not increased by this call.  Returns the virConnectPtr or NULL in case of failure.'/>
+      <info>Provides the connection pointer associated with a network.  The reference counter on the connection is not increased by this call.</info>
+      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
      <arg name='net' type='virNetworkPtr' info='pointer to a network'/>
    </function>
    <function name='virNetworkGetName' file='libvirt' module='libvirt'>
@@ -1058,10 +1058,12 @@
          <ref name='virConnectNumOfDomains'/>
          <ref name='virConnectNumOfNetworks'/>
          <ref name='virDomainGetAutostart'/>
+          <ref name='virDomainGetConnect'/>
          <ref name='virDomainGetMaxVcpus'/>
          <ref name='virGetVersion'/>
          <ref name='virNetworkGetAutostart'/>
          <ref name='virNetworkGetBridgeName'/>
+          <ref name='virNetworkGetConnect'/>
        </word>
      </letter>
      <letter name='R'>
@@ -1086,10 +1088,6 @@
        <word name='Retrieve'>
          <ref name='virDomainGetMaxMemory'/>
        </word>
-        <word name='Returns'>
-          <ref name='virDomainGetConnect'/>
-          <ref name='virNetworkGetConnect'/>
-        </word>
      </letter>
      <letter name='S'>
        <word name='See'>
@@ -476,20 +476,19 @@
  </xsl:template>

  <xsl:template name="docomponents">
-    <xsl:param name="mode"/>
-    <xsl:apply-templates select="exports[@type='macro']" mode="$mode">
+    <xsl:apply-templates select="exports[@type='macro']">
      <xsl:sort select='@symbol'/>
    </xsl:apply-templates>
-    <xsl:apply-templates select="exports[@type='enum']" mode="$mode">
+    <xsl:apply-templates select="exports[@type='enum']">
      <xsl:sort select='@symbol'/>
    </xsl:apply-templates>
-    <xsl:apply-templates select="exports[@type='typedef']" mode="$mode">
+    <xsl:apply-templates select="exports[@type='typedef']">
      <xsl:sort select='@symbol'/>
    </xsl:apply-templates>
-    <xsl:apply-templates select="exports[@type='struct']" mode="$mode">
+    <xsl:apply-templates select="exports[@type='struct']">
      <xsl:sort select='@symbol'/>
    </xsl:apply-templates>
-    <xsl:apply-templates select="exports[@type='function']" mode="$mode">
+    <xsl:apply-templates select="exports[@type='function']">
      <xsl:sort select='@symbol'/>
    </xsl:apply-templates>
  </xsl:template>