docs: fix indentation of sub-elements of <ip> in network XML

The sub-elements of <ip> had been placed at the same level of
indentation as ip itself, implying that they were really elements of
<network>. Within that, sub-elements of ip/dhcp were also at that same
level. These have been double-indented.

At the same time, I realized that the documentation for the new <dns>
element had been placed right in the middle of the description of the
sub-elements of <ip>. I moved it up out of the way.

diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in
index cbec7af59e26686616b149e7443a2fd505e45e4a..f9421c3f84ea5ac18845d85e9f17d330d69f6d53 100644 (file)
--- a/docs/formatnetwork.html.in
+++ b/docs/formatnetwork.html.in
@@ -142,35 +142,6 @@
         with the idiosyncrasies of the platform where libvirt is
         running. <span class="since">Since 0.8.8</span>
       </dd>
-      <dt><code>ip</code></dt>
-      <dd>The <code>address</code> attribute defines an IPv4 address in
-        dotted-decimal format, or an IPv6 address in standard
-        colon-separated hexadecimal format, that will be configured on
-        the bridge
-        device associated with the virtual network. To the guests this
-        address will be their default route. For IPv4 addresses, the <code>netmask</code>
-        attribute defines the significant bits of the network address,
-        again specified in dotted-decimal format.  For IPv6 addresses,
-        and as an alternate method for IPv4 addresses, you can specify
-        the significant bits of the network address with the <code>prefix</code>
-        attribute, which is an integer (for example, <code>netmask='255.255.255.0'</code>
-        could also be given as <code>prefix='24'</code>. The <code>family</code>
-        attribute is used to specify the type of address - 'ipv4' or 'ipv6'; if no
-        <code>family</code> is given, 'ipv4' is assumed. A network can have more than
-        one of each family of address defined, but only a single address can have a
-        <code>dhcp</code> or <code>tftp</code> element. <span class="since">Since 0.3.0;
-        IPv6, multiple addresses on a single network, <code>family</code>, and
-        <code>prefix</code> since 0.8.7</span>
-      </dd><dt><code>tftp</code></dt><dd>Immediately within
-        the <code>ip</code> element there is an optional <code>tftp</code>
-        element. The presence of this element and of its attribute
-        <code>root</code> enables TFTP services.  The attribute specifies
-        the path to the root directory served via TFTP. <code>tftp</code> is not
-        supported for IPv6 addresses, can only be specified on a single IPv4 address
-        per network.
-        <span class="since">Since 0.7.1</span>
-      </dd>
-
       <dt><code>dns</code></dt><dd>
         The dns element of a network contains configuration information for the
         virtual network's DNS server. <span class="since">Since 0.9.3</span>
@@ -194,41 +165,78 @@
           </dd>
         </dl>
       </dd>
-      <dt><code>dhcp</code></dt>
-      <dd>Also within the <code>ip</code> element there is an
-        optional <code>dhcp</code> element. The presence of this element
-        enables DHCP services on the virtual network. It will further
-        contain one or more <code>range</code> elements. The
-        <code>dhcp</code> element is not supported for IPv6, and
-        is only supported on a single IP address per network for IPv4.
-        <span class="since">Since 0.3.0</span>
-      </dd>
-      <dt><code>range</code></dt>
-      <dd>The <code>start</code> and <code>end</code> attributes on the
-        <code>range</code> element specify the boundaries of a pool of
-        IPv4 addresses to be provided to DHCP clients. These two addresses
-        must lie within the scope of the network defined on the parent
-        <code>ip</code> element.  <span class="since">Since 0.3.0</span>
-      </dd>
-      <dt><code>host</code></dt>
-      <dd>Within the <code>dhcp</code> element there may be zero or more
-        <code>host</code> elements; these specify hosts which will be given
-        names and predefined IP addresses by the built-in DHCP server. Any
-        such element must specify the MAC address of the host to be assigned
-        a given name (via the <code>mac</code> attribute), the IP to be
-        assigned to that host (via the <code>ip</code> attribute), and the
-        name to be given that host by the DHCP server (via the
-        <code>name</code> attribute).  <span class="since">Since 0.4.5</span>
-      </dd><dt><code>bootp</code></dt><dd>The optional <code>bootp</code>
-        element specifies BOOTP options to be provided by the DHCP server.
-        Two attributes are supported: <code>file</code> is mandatory and
-        gives the file to be used for the boot image; <code>server</code> is
-        optional and gives the address of the TFTP server from which the boot
-        image will be fetched.  <code>server</code> defaults to the same host
-        that runs the DHCP server, as is the case when the <code>tftp</code>
-        element is used.  The BOOTP options currently have to be the same
-        for all address ranges and statically assigned addresses.<span
-        class="since">Since 0.7.1 (<code>server</code> since 0.7.3).</span>
+      <dt><code>ip</code></dt>
+      <dd>The <code>address</code> attribute defines an IPv4 address in
+        dotted-decimal format, or an IPv6 address in standard
+        colon-separated hexadecimal format, that will be configured on
+        the bridge
+        device associated with the virtual network. To the guests this
+        address will be their default route. For IPv4 addresses, the <code>netmask</code>
+        attribute defines the significant bits of the network address,
+        again specified in dotted-decimal format.  For IPv6 addresses,
+        and as an alternate method for IPv4 addresses, you can specify
+        the significant bits of the network address with the <code>prefix</code>
+        attribute, which is an integer (for example, <code>netmask='255.255.255.0'</code>
+        could also be given as <code>prefix='24'</code>. The <code>family</code>
+        attribute is used to specify the type of address - 'ipv4' or 'ipv6'; if no
+        <code>family</code> is given, 'ipv4' is assumed. A network can have more than
+        one of each family of address defined, but only a single address can have a
+        <code>dhcp</code> or <code>tftp</code> element. <span class="since">Since 0.3.0;
+        IPv6, multiple addresses on a single network, <code>family</code>, and
+        <code>prefix</code> since 0.8.7</span>
+        <dl>
+          <dt><code>tftp</code></dt>
+          <dd>Immediately within
+            the <code>ip</code> element there is an optional <code>tftp</code>
+            element. The presence of this element and of its attribute
+            <code>root</code> enables TFTP services.  The attribute specifies
+            the path to the root directory served via TFTP. <code>tftp</code> is not
+            supported for IPv6 addresses, and can only be specified on a single IPv4 address
+            per network.
+            <span class="since">Since 0.7.1</span>
+          </dd>
+
+          <dt><code>dhcp</code></dt>
+          <dd>Also within the <code>ip</code> element there is an
+            optional <code>dhcp</code> element. The presence of this element
+            enables DHCP services on the virtual network. It will further
+            contain one or more <code>range</code> elements. The
+            <code>dhcp</code> element is not supported for IPv6, and
+            is only supported on a single IP address per network for IPv4.
+            <span class="since">Since 0.3.0</span>
+            <dl>
+              <dt><code>range</code></dt>
+              <dd>The <code>start</code> and <code>end</code> attributes on the
+                <code>range</code> element specify the boundaries of a pool of
+                IPv4 addresses to be provided to DHCP clients. These two addresses
+                must lie within the scope of the network defined on the parent
+                <code>ip</code> element.  <span class="since">Since 0.3.0</span>
+              </dd>
+              <dt><code>host</code></dt>
+              <dd>Within the <code>dhcp</code> element there may be zero or more
+                <code>host</code> elements; these specify hosts which will be given
+                names and predefined IP addresses by the built-in DHCP server. Any
+                such element must specify the MAC address of the host to be assigned
+                a given name (via the <code>mac</code> attribute), the IP to be
+                assigned to that host (via the <code>ip</code> attribute), and the
+                name to be given that host by the DHCP server (via the
+                <code>name</code> attribute).  <span class="since">Since 0.4.5</span>
+              </dd>
+              <dt><code>bootp</code></dt>
+              <dd>The optional <code>bootp</code>
+                element specifies BOOTP options to be provided by the DHCP server.
+                Two attributes are supported: <code>file</code> is mandatory and
+                gives the file to be used for the boot image; <code>server</code> is
+                optional and gives the address of the TFTP server from which the boot
+                image will be fetched.  <code>server</code> defaults to the same host
+                that runs the DHCP server, as is the case when the <code>tftp</code>
+                element is used.  The BOOTP options currently have to be the same
+                for all address ranges and statically assigned addresses.<span
+                class="since">Since 0.7.1 (<code>server</code> since 0.7.3).</span>
+              </dd>
+            </dl>
+          </dd>
+        </dl>
       </dd>
     </dl>