5:10 p.m.
The first patch actually makes changes to the html tags, and re-orders
some of the paragraphs. The second patch is only whitespace changes.
5:11 p.m.
New subject: [libvirt] [PATCH 1/2] 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.
---
docs/formatnetwork.html.in | 58 +++++++++++++++++++++++--------------------
1 files changed, 31 insertions(+), 27 deletions(-)
diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in
index cbec7af..93b0ebe 100644
--- a/docs/formatnetwork.html.in
+++ b/docs/formatnetwork.html.in
@@ -142,6 +142,29 @@
with the idiosyncrasies of the platform where libvirt is
running. <span class="since">Since 0.8.8</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>
+ Currently supported elements are:
+ <dl>
+ <dt><code>txt</code></dt>
+ <dd>A <code>dns</code> element can have 0 or more
<code>txt</code> elements.
+ Each txt element defines a DNS TXT record and has two attributes, both
+ required: a name that can be queried via dns, and a value that will be
+ returned when that name is queried. names cannot contain embedded spaces
+ or commas. value is a single string that can contain multiple values
+ separated by commas. <span class="since">Since
0.9.3</span>
+ </dd>
+ <dt><code>host</code></dt>
+ <dd>The <code>host</code> element within
<code>dns</code> is the
+ definition of DNS hosts to be passed to the DNS service. The IP
+ address is identified by the <code>ip</code> attribute and the
names
+ for that IP address are identified in the <code>hostname</code>
+ sub-elements of the <code>host</code> element.
+ <span class="since">Since 0.9.3</span>
+ </dd>
+ </dl>
+ </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
@@ -161,39 +184,16 @@
<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
+ <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, can only be specified on a single IPv4 address
+ 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>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>
- Currently supported elements are:
- <dl>
- <dt><code>txt</code></dt>
- <dd>A <code>dns</code> element can have 0 or more
<code>txt</code> elements.
- Each txt element defines a DNS TXT record and has two attributes, both
- required: a name that can be queried via dns, and a value that will be
- returned when that name is queried. names cannot contain embedded spaces
- or commas. value is a single string that can contain multiple values
- separated by commas. <span class="since">Since
0.9.3</span>
- </dd>
- <dt><code>host</code></dt>
- <dd>The <code>host</code> element within
<code>dns</code> is the
- definition of DNS hosts to be passed to the DNS service. The IP
- address is identified by the <code>ip</code> attribute and the
names
- for that IP address are identified in the <code>hostname</code>
- sub-elements of the <code>host</code> element.
- <span class="since">Since 0.9.3</span>
- </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
@@ -202,7 +202,7 @@
<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>
+ <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
@@ -229,6 +229,10 @@
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>
+ </dl>
+ </dd>
+ </dd>
+ </dl>
</dd>
</dl>
--
1.7.3.4
5:11 p.m.
New subject: [libvirt] [PATCH 2/2] docs: re-indent the source for readability while editing
---
docs/formatnetwork.html.in | 102 +++++++++++++++++++++++---------------------
1 files changed, 53 insertions(+), 49 deletions(-)
diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in
index 93b0ebe..f9421c3 100644
--- a/docs/formatnetwork.html.in
+++ b/docs/formatnetwork.html.in
@@ -184,55 +184,59 @@
<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>
- </dl>
- </dd>
- </dd>
- </dl>
+ <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>
--
1.7.3.4
5:23 p.m.
New subject: [libvirt] [PATCH 0/2] docs: fix indentation of sub-elements of <ip> in network XML
On 06/24/2011 04:10 PM, Laine Stump wrote:
The first patch actually makes changes to the html tags, and re-orders
some of the paragraphs. The second patch is only whitespace changes.
ACK series.
--
Eric Blake eblake(a)redhat.com +1-801-349-2682
Libvirt virtualization library http://libvirt.org
5:29 p.m.
New subject: [libvirt] [PATCH 0/2] docs: fix indentation of sub-elements of <ip> in network XML
On 06/24/2011 06:23 PM, Eric Blake wrote:
On 06/24/2011 04:10 PM, Laine Stump wrote:
> The first patch actually makes changes to the html tags, and re-orders
> some of the paragraphs. The second patch is only whitespace changes.
ACK series.
Squashed into 1 commit and pushed. Thanks!
4937
days inactive
4937
days old
4 comments
2 participants
participants (2)
-
Eric Blake -
Laine Stump