[libvirt] [PATCH 00/10] Various documentation updates
Over the months I've noticed a few XML pieces that aren't documented, so I finally sat down to hammer these out. Patch #1 is actually a bug I noticed in the process of trying to document the affected attribute. Thanks, Cole Cole Robinson (10): storage: conf: Correctly calculate exabyte unit docs: storage: Document capacity/alloc 'unit' docs: storage: <volume><key> is always generated. docs: storage: Fix backingStore <format> docs docs: storage: Document <auth> element docs: storage: Document SCSI pools docs: storage: Document multipath pools docs: domain: Document <description> element docs: network: Document STP and delay attributes docs: network: Document <domain> element docs/formatdomain.html.in | 7 ++++ docs/formatnetwork.html.in | 12 ++++++- docs/formatstorage.html.in | 34 ++++++++++++++++--- docs/storage.html.in | 76 ++++++++++++++++++++++++++++++++++++++++++++ src/conf/storage_conf.c | 4 +- 5 files changed, 124 insertions(+), 9 deletions(-)
We were using 'Y' to mean exabyte, when the correct abbreviation would be 'E' ('Y' is yettabyte, which is exabyte * 1024 * 1024). While it isn't strictly backwards compatible, I highly doubt anyone was actually using this broken behavior, so I don't see any harm in in dropping 'Y' handling. Signed-off-by: Cole Robinson <crobinso@redhat.com> --- src/conf/storage_conf.c | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/conf/storage_conf.c b/src/conf/storage_conf.c index eefa55f..19a1db9 100644 --- a/src/conf/storage_conf.c +++ b/src/conf/storage_conf.c @@ -980,8 +980,8 @@ virStorageSize(const char *unit, mult = 1024ull * 1024ull * 1024ull * 1024ull * 1024ull; break; - case 'y': - case 'Y': + case 'e': + case 'E': mult = 1024ull * 1024ull * 1024ull * 1024ull * 1024ull * 1024ull; break; -- 1.6.6
On Mon, Feb 22, 2010 at 05:10:49PM -0500, Cole Robinson wrote:
We were using 'Y' to mean exabyte, when the correct abbreviation would be 'E' ('Y' is yettabyte, which is exabyte * 1024 * 1024). While it isn't strictly backwards compatible, I highly doubt anyone was actually using this broken behavior, so I don't see any harm in in dropping 'Y' handling.
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- src/conf/storage_conf.c | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/conf/storage_conf.c b/src/conf/storage_conf.c index eefa55f..19a1db9 100644 --- a/src/conf/storage_conf.c +++ b/src/conf/storage_conf.c @@ -980,8 +980,8 @@ virStorageSize(const char *unit, mult = 1024ull * 1024ull * 1024ull * 1024ull * 1024ull; break;
- case 'y': - case 'Y': + case 'e': + case 'E': mult = 1024ull * 1024ull * 1024ull * 1024ull * 1024ull * 1024ull; break;
Yeah, it's bad to change this but better to fix now while unlikely to be used than keeping this as-is, ACK, Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatstorage.html.in | 12 ++++++++++-- 1 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 5c41c39..6dbe0ca 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -215,10 +215,18 @@ allocated at time of creation. If set to a value smaller than the capacity, the pool has the <strong>option</strong> of deciding to sparsely allocate a volume. It does not have to honour requests - for sparse allocation though. <span class="since">Since 0.4.1</span></dd> + for sparse allocation though.<br/> + <br/> + By default this is specified in bytes, but an optional + <code>unit</code> can be specified to adjust the passed value. + Values can be: 'K' (kilobytes), 'M' (megabytes), 'G' (gigabytes), + 'T' (terabytes), 'P' (petabytes), or 'E' (exabytes). + <span class="since">Since 0.4.1</span></dd> <dt><code>capacity</code></dt> <dd>Providing the logical capacity for the volume. This value is - in bytes. This is compulsory when creating a volume. + in bytes by default, but a <code>unit</code> attribute can be + specified with the same semantics as for <code>allocation</code> + This is compulsory when creating a volume. <span class="since">Since 0.4.1</span></dd> <dt><code>source</code></dt> <dd>Provides information about the underlying storage allocation -- 1.6.6
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatstorage.html.in | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 6dbe0ca..14fa655 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -204,8 +204,8 @@ This is mandatory when defining a volume. <span class="since">Since 0.4.1</span></dd> <dt><code>key</code></dt> <dd>Providing an identifier for the volume which is globally unique. - This is optional when defining a volume, a key will be generated if - omitted. <span class="since">Since 0.4.1</span></dd> + This cannot be set when creating a volume: it is always generated. + <span class="since">Since 0.4.1</span></dd> <dt><code>allocation</code></dt> <dd>Providing the total storage allocation for the volume. This may be smaller than the logical capacity if the volume is sparsely -- 1.6.6
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatstorage.html.in | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 14fa655..7ececed 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -300,7 +300,7 @@ ... <backingStore> <path>/var/lib/virt/images/master.img</path> - <format>raw</format> + <format type='raw'/> <permissions> <owner>107</owner> <group>107</group> @@ -320,7 +320,8 @@ <dd>Provides information about the pool specific backing store format. For disk pools it will provide the partition type. For filesystem or directory pools it will provide the file format type, eg cow, - qcow, vmdk, raw. Consult the pool-specific docs for the list of valid + qcow, vmdk, raw. The actual format is specified via the type attribute. + Consult the pool-specific docs for the list of valid values. Most file formats require a backing store of the same format, however, the qcow2 format allows a different backing store format. <span class="since">Since 0.6.0</span></dd> -- 1.6.6
On Mon, Feb 22, 2010 at 05:10:52PM -0500, Cole Robinson wrote:
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatstorage.html.in | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 14fa655..7ececed 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -300,7 +300,7 @@ ... <backingStore> <path>/var/lib/virt/images/master.img</path> - <format>raw</format> + <format type='raw'/> <permissions> <owner>107</owner> <group>107</group> @@ -320,7 +320,8 @@ <dd>Provides information about the pool specific backing store format. For disk pools it will provide the partition type. For filesystem or directory pools it will provide the file format type, eg cow, - qcow, vmdk, raw. Consult the pool-specific docs for the list of valid + qcow, vmdk, raw. The actual format is specified via the type attribute. + Consult the pool-specific docs for the list of valid
having a link for "pool-specific docs" would be a nice improvement :-)
values. Most file formats require a backing store of the same format, however, the qcow2 format allows a different backing store format. <span class="since">Since 0.6.0</span></dd>
ACK, Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatstorage.html.in | 8 ++++++++ docs/storage.html.in | 1 + 2 files changed, 9 insertions(+), 0 deletions(-) diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 7ececed..855d475 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -70,6 +70,7 @@ <source> <host name="iscsi.example.com"/> <device path="demo-target"/> + <auth type="chap" login="foobar" passwd="foo-passwd"/> </source> ...</pre> @@ -103,6 +104,13 @@ type, or network filesystem type, or partition table type, or LVM metadata type. All drivers are required to have a default value for this, so it is optional. <span class="since">Since 0.4.1</span></dd> + <dt><code>auth</code></dt> + <dd>Provides login information for an iSCSI pools server. + <code>type</code> is a required attribute which specifies the + authentication method. Currently only <code>chap</code> + (challenge-handshake) is supported. <code>login</code> and + <code>passwd</code> specify the login and password respectively. + <span class="since">Since 0.4.1</span></dd> </dl> <h3><a name="StoragePoolTarget">Target elements</a></h3> diff --git a/docs/storage.html.in b/docs/storage.html.in index 904fc7c..a3399c6 100644 --- a/docs/storage.html.in +++ b/docs/storage.html.in @@ -329,6 +329,7 @@ libvirt. <source> <host name="iscsi.example.com"/> <device path="demo-target"/> + <auth type="chap" login="foobar" passwd="foo-passwd"/> </source> <target> <path>/dev/disk/by-path</path> -- 1.6.6
On Mon, Feb 22, 2010 at 05:10:53PM -0500, Cole Robinson wrote:
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatstorage.html.in | 8 ++++++++ docs/storage.html.in | 1 + 2 files changed, 9 insertions(+), 0 deletions(-)
diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 7ececed..855d475 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -70,6 +70,7 @@ <source> <host name="iscsi.example.com"/> <device path="demo-target"/> + <auth type="chap" login="foobar" passwd="foo-passwd"/> </source> ...</pre>
@@ -103,6 +104,13 @@ type, or network filesystem type, or partition table type, or LVM metadata type. All drivers are required to have a default value for this, so it is optional. <span class="since">Since 0.4.1</span></dd> + <dt><code>auth</code></dt> + <dd>Provides login information for an iSCSI pools server. + <code>type</code> is a required attribute which specifies the + authentication method. Currently only <code>chap</code> + (challenge-handshake) is supported. <code>login</code> and + <code>passwd</code> specify the login and password respectively. + <span class="since">Since 0.4.1</span></dd> </dl>
<h3><a name="StoragePoolTarget">Target elements</a></h3>
Our iSCSI backend never actually implemented any of this, so its a little bit misleading & probably a bad idea in the XML in any case. I'm inclined to actually remove this from the XML parser since it was never used.
diff --git a/docs/storage.html.in b/docs/storage.html.in index 904fc7c..a3399c6 100644 --- a/docs/storage.html.in +++ b/docs/storage.html.in @@ -329,6 +329,7 @@ libvirt. <source> <host name="iscsi.example.com"/> <device path="demo-target"/> + <auth type="chap" login="foobar" passwd="foo-passwd"/> </source> <target> <path>/dev/disk/by-path</path> --
Daniel -- |: Red Hat, Engineering, London -o- http://people.redhat.com/berrange/ :| |: http://libvirt.org -o- http://virt-manager.org -o- http://deltacloud.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: GnuPG: 7D3B9505 -o- F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|
On 02/23/2010 02:51 AM, Daniel P. Berrange wrote:
On Mon, Feb 22, 2010 at 05:10:53PM -0500, Cole Robinson wrote:
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatstorage.html.in | 8 ++++++++ docs/storage.html.in | 1 + 2 files changed, 9 insertions(+), 0 deletions(-)
diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 7ececed..855d475 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -70,6 +70,7 @@ <source> <host name="iscsi.example.com"/> <device path="demo-target"/> + <auth type="chap" login="foobar" passwd="foo-passwd"/> </source> ...</pre>
@@ -103,6 +104,13 @@ type, or network filesystem type, or partition table type, or LVM metadata type. All drivers are required to have a default value for this, so it is optional. <span class="since">Since 0.4.1</span></dd> + <dt><code>auth</code></dt> + <dd>Provides login information for an iSCSI pools server. + <code>type</code> is a required attribute which specifies the + authentication method. Currently only <code>chap</code> + (challenge-handshake) is supported. <code>login</code> and + <code>passwd</code> specify the login and password respectively. + <span class="since">Since 0.4.1</span></dd> </dl>
<h3><a name="StoragePoolTarget">Target elements</a></h3>
Our iSCSI backend never actually implemented any of this, so its a little bit misleading & probably a bad idea in the XML in any case. I'm inclined to actually remove this from the XML parser since it was never used.
Huh, I never actually confirmed it worked :) Figuring that the XML generation was broken for this up until 0.7.2 I believe, there is probably no harm in removing it. I'll cook up a patch. Thanks, Cole
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatstorage.html.in | 5 +++++ docs/storage.html.in | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 0 deletions(-) diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 855d475..8f62f73 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -85,6 +85,11 @@ only occur once. Contains a single attribute <code>path</code> which is the fully qualified path to the block device node. <span class="since">Since 0.4.1</span></dd> + <dt><code>adapter</code></dt> + <dd>Provides the source for pools backed by SCSI adapters. May + only occur once. Contains a single attribute <code>name</code> + which is the SCSI adapter name (ex. "host1"). + <span class="since">Since 0.6.2</span></dd> <dt><code>host</code></dt> <dd>Provides the source for pools backed by storage from a remote server. Will be used in combination with a <code>directory</code> diff --git a/docs/storage.html.in b/docs/storage.html.in index a3399c6..c179945 100644 --- a/docs/storage.html.in +++ b/docs/storage.html.in @@ -25,6 +25,9 @@ libvirt. <li> <a href="#StorageBackendISCSI">iSCSI backend</a> </li> + <li> + <a href="#StorageBackendSCSI">SCSI backend</a> + </li> </ul> <h2><a name="StorageBackendDir" id="StorageBackendDir">Directory pool</a></h2> @@ -345,5 +348,39 @@ libvirt. <p> The iSCSI volume pool does not use the volume format type element. </p> + + <h2><a name="StorageBackendSCSI" id="StorageBackendSCSI">SCSI volume pools</a></h2> + <p> + This provides a pool based on a SCSI HBA. Volumes are preexisting SCSI + LUNs, and cannot be created via the libvirt APIs. Since /dev/XXX names + aren't generally stable, it is recommended to configure the pool + to use <code>/dev/disk/by-path</code> or <code>/dev/disk/by-id</code> + for the target path. These provide persistent stable naming for LUNs + <span class="since">Since 0.6.2</span></dd> + </p> + + <h3>Example pool input</h3> + <pre> + <pool type="scsi"> + <name>virtimages</name> + <source> + <adapter name="host0"/> + </source> + <target> + <path>/dev/disk/by-path</path> + </target> + </pool></pre> + + <h3>Valid pool format types</h3> + <p> + The SCSI volume pool does not use the pool format type element. + </p> + + <h3>Valid volume format types</h3> + <p> + The SCSI volume pool does not use the volume format type element. + </p> + + </body> </html> -- 1.6.6
On 02/22/2010 05:10 PM, Cole Robinson wrote:
Signed-off-by: Cole Robinson<crobinso@redhat.com> --- docs/formatstorage.html.in | 5 +++++ docs/storage.html.in | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 0 deletions(-)
diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 855d475..8f62f73 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -85,6 +85,11 @@ only occur once. Contains a single attribute<code>path</code> which is the fully qualified path to the block device node. <span class="since">Since 0.4.1</span></dd> +<dt><code>adapter</code></dt> +<dd>Provides the source for pools backed by SCSI adapters. May + only occur once. Contains a single attribute<code>name</code> + which is the SCSI adapter name (ex. "host1"). +<span class="since">Since 0.6.2</span></dd> <dt><code>host</code></dt> <dd>Provides the source for pools backed by storage from a remote server. Will be used in combination with a<code>directory</code> diff --git a/docs/storage.html.in b/docs/storage.html.in index a3399c6..c179945 100644 --- a/docs/storage.html.in +++ b/docs/storage.html.in @@ -25,6 +25,9 @@ libvirt. <li> <a href="#StorageBackendISCSI">iSCSI backend</a> </li> +<li> +<a href="#StorageBackendSCSI">SCSI backend</a> +</li> </ul>
<h2><a name="StorageBackendDir" id="StorageBackendDir">Directory pool</a></h2> @@ -345,5 +348,39 @@ libvirt. <p> The iSCSI volume pool does not use the volume format type element. </p> + +<h2><a name="StorageBackendSCSI" id="StorageBackendSCSI">SCSI volume pools</a></h2> +<p> + This provides a pool based on a SCSI HBA. Volumes are preexisting SCSI + LUNs, and cannot be created via the libvirt APIs. Since /dev/XXX names + aren't generally stable, it is recommended to configure the pool + to use<code>/dev/disk/by-path</code> or<code>/dev/disk/by-id</code> + for the target path. These provide persistent stable naming for LUNs +<span class="since">Since 0.6.2</span></dd> +</p> + +<h3>Example pool input</h3> +<pre> +<pool type="scsi"> +<name>virtimages</name> +<source> +<adapter name="host0"/> +</source> +<target> +<path>/dev/disk/by-path</path> +</target> +</pool></pre> + +<h3>Valid pool format types</h3> +<p> + The SCSI volume pool does not use the pool format type element. +</p> + +<h3>Valid volume format types</h3> +<p> + The SCSI volume pool does not use the volume format type element. +</p> + + </body> </html>
After the fact, but ACK. Thanks for doing this. Dave
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/storage.html.in | 38 ++++++++++++++++++++++++++++++++++++++ 1 files changed, 38 insertions(+), 0 deletions(-) diff --git a/docs/storage.html.in b/docs/storage.html.in index c179945..a1b3322 100644 --- a/docs/storage.html.in +++ b/docs/storage.html.in @@ -28,6 +28,9 @@ libvirt. <li> <a href="#StorageBackendSCSI">SCSI backend</a> </li> + <li> + <a href="#StorageBackendMultipath">Multipath backend</a> + </li> </ul> <h2><a name="StorageBackendDir" id="StorageBackendDir">Directory pool</a></h2> @@ -381,6 +384,41 @@ libvirt. The SCSI volume pool does not use the volume format type element. </p> + <h2><a name="StorageBackendMultipath" id="StorageBackendMultipath">Multipath pools</a></h2> + <p> + This provides a pool that contains all the multipath devices on the + host. Volume creating is not supported via the libvirt APIs. + The target element is actually ignored, but one is required to appease + the libvirt XML parser.<br/> + <br/> + Configuring multipathing is not currently supported, this just covers + the case where users want to discover all the available multipath + devices, and assign them to guests. + <span class="since">Since 0.7.1</span></dd> + </p> + + <h3>Example pool input</h3> + <pre> + <pool type="mpath"> + <name>virtimages</name> + <target> + <path>/dev/mapper</path> + </target> + </pool></pre> + + <h3>Valid pool format types</h3> + <p> + The Multipath volume pool does not use the pool format type element. + </p> + + <h3>Valid volume format types</h3> + <p> + The Multipath volume pool does not use the volume format type element. + </p> + + + </body> +</html> </body> </html> -- 1.6.6
On 02/22/2010 05:10 PM, Cole Robinson wrote:
Signed-off-by: Cole Robinson<crobinso@redhat.com> --- docs/storage.html.in | 38 ++++++++++++++++++++++++++++++++++++++ 1 files changed, 38 insertions(+), 0 deletions(-)
diff --git a/docs/storage.html.in b/docs/storage.html.in index c179945..a1b3322 100644 --- a/docs/storage.html.in +++ b/docs/storage.html.in @@ -28,6 +28,9 @@ libvirt. <li> <a href="#StorageBackendSCSI">SCSI backend</a> </li> +<li> +<a href="#StorageBackendMultipath">Multipath backend</a> +</li> </ul>
<h2><a name="StorageBackendDir" id="StorageBackendDir">Directory pool</a></h2> @@ -381,6 +384,41 @@ libvirt. The SCSI volume pool does not use the volume format type element. </p>
+<h2><a name="StorageBackendMultipath" id="StorageBackendMultipath">Multipath pools</a></h2> +<p> + This provides a pool that contains all the multipath devices on the + host. Volume creating is not supported via the libvirt APIs. + The target element is actually ignored, but one is required to appease + the libvirt XML parser.<br/> +<br/> + Configuring multipathing is not currently supported, this just covers + the case where users want to discover all the available multipath + devices, and assign them to guests. +<span class="since">Since 0.7.1</span></dd> +</p> + +<h3>Example pool input</h3> +<pre> +<pool type="mpath"> +<name>virtimages</name> +<target> +<path>/dev/mapper</path> +</target> +</pool></pre> + +<h3>Valid pool format types</h3> +<p> + The Multipath volume pool does not use the pool format type element. +</p> + +<h3>Valid volume format types</h3> +<p> + The Multipath volume pool does not use the volume format type element. +</p> + + +</body> +</html>
</body> </html>
ACK to this as well.
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatdomain.html.in | 7 +++++++ 1 files changed, 7 insertions(+), 0 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 083a80a..3212209 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -32,6 +32,7 @@ <domain type='xen' id='3'> <name>fv0</name> <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid> + <description>Some human readable description</description> ...</pre> <dl> @@ -48,6 +49,12 @@ The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>. If omitted when defining/creating a new machine, a random UUID is generated. <span class="since">Since 0.0.1</span></dd> + + <dt><code>description</code></dt> + <dd>The content of the <code>description</code> element provides a + human readable description of the virtual machine. This data is not + used by libvirt in any way, it can contain any information the user + wants. <span class="since">Since 0.7.2</span></dd> </dl> <h3><a name="elementsOS">Operating system booting</a></h3> -- 1.6.6
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatnetwork.html.in | 5 ++++- 1 files changed, 4 insertions(+), 1 deletions(-) diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in index b39f353..36c0053 100644 --- a/docs/formatnetwork.html.in +++ b/docs/formatnetwork.html.in @@ -57,7 +57,7 @@ <pre> ... - <bridge name="virbr0" /> + <bridge name="virbr0" stp="on" delay="5"/> <forward mode="nat" dev="eth0"/> ...</pre> @@ -71,6 +71,9 @@ device names started with the prefix <code>vir</code>, but the name <code>virbr0</code> is reserved for the "default" virtual network. This element should always be provided when defining a new network. + Attribute <code>stp</code> specifies if Spanning Tree Protocol is + 'on' or 'off' (default is 'on'). Attribute <code>delay</code> sets + the bridge's forward delay value in seconds (default is 0). <span class="since">Since 0.3.0</span> </dd> <dt><code>forward</code></dt> -- 1.6.6
Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/formatnetwork.html.in | 7 +++++++ 1 files changed, 7 insertions(+), 0 deletions(-) diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in index 36c0053..7a24518 100644 --- a/docs/formatnetwork.html.in +++ b/docs/formatnetwork.html.in @@ -58,6 +58,7 @@ <pre> ... <bridge name="virbr0" stp="on" delay="5"/> + <domain name="example"/> <forward mode="nat" dev="eth0"/> ...</pre> @@ -76,6 +77,12 @@ the bridge's forward delay value in seconds (default is 0). <span class="since">Since 0.3.0</span> </dd> + <dt><code>domain</code></dt> + <dd> + The <code>name</code> attribute on the <code>domain</code> element + defines the DNS domain of the DHCP server. This element is optional. + <span class="since">Since 0.4.5</span> + </dd> <dt><code>forward</code></dt> <dd>Inclusion of the <code>forward</code> element indicates that the virtual network is to be connected to the physical LAN. If -- 1.6.6
On Mon, Feb 22, 2010 at 05:10:48PM -0500, Cole Robinson wrote:
Over the months I've noticed a few XML pieces that aren't documented, so I finally sat down to hammer these out. Patch #1 is actually a bug I noticed in the process of trying to document the affected attribute.
Thanks, Cole
Cole Robinson (10): storage: conf: Correctly calculate exabyte unit docs: storage: Document capacity/alloc 'unit' docs: storage: <volume><key> is always generated. docs: storage: Fix backingStore <format> docs docs: storage: Document <auth> element docs: storage: Document SCSI pools docs: storage: Document multipath pools docs: domain: Document <description> element docs: network: Document STP and delay attributes docs: network: Document <domain> element
docs/formatdomain.html.in | 7 ++++ docs/formatnetwork.html.in | 12 ++++++- docs/formatstorage.html.in | 34 ++++++++++++++++--- docs/storage.html.in | 76 ++++++++++++++++++++++++++++++++++++++++++++ src/conf/storage_conf.c | 4 +- 5 files changed, 124 insertions(+), 9 deletions(-)
ACK except for patch 5 Daniel -- |: Red Hat, Engineering, London -o- http://people.redhat.com/berrange/ :| |: http://libvirt.org -o- http://virt-manager.org -o- http://deltacloud.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: GnuPG: 7D3B9505 -o- F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|
On 02/23/2010 02:52 AM, Daniel P. Berrange wrote:
On Mon, Feb 22, 2010 at 05:10:48PM -0500, Cole Robinson wrote:
Over the months I've noticed a few XML pieces that aren't documented, so I finally sat down to hammer these out. Patch #1 is actually a bug I noticed in the process of trying to document the affected attribute.
Thanks, Cole
Cole Robinson (10): storage: conf: Correctly calculate exabyte unit docs: storage: Document capacity/alloc 'unit' docs: storage: <volume><key> is always generated. docs: storage: Fix backingStore <format> docs docs: storage: Document <auth> element docs: storage: Document SCSI pools docs: storage: Document multipath pools docs: domain: Document <description> element docs: network: Document STP and delay attributes docs: network: Document <domain> element
docs/formatdomain.html.in | 7 ++++ docs/formatnetwork.html.in | 12 ++++++- docs/formatstorage.html.in | 34 ++++++++++++++++--- docs/storage.html.in | 76 ++++++++++++++++++++++++++++++++++++++++++++ src/conf/storage_conf.c | 4 +- 5 files changed, 124 insertions(+), 9 deletions(-)
ACK except for patch 5
Thanks, pushed all except 5. - Cole
participants (4)
-
Cole Robinson -
Daniel P. Berrange -
Daniel Veillard -
Dave Allan