8:23 a.m.
This patch adds a new element <title> to the domain XML. This attribute
can hold a short title defined by the user to ease the identification of
domains. The title is limited to 40 bytes and can't contain newlines.
*docs/formatdomain.html.in
*docs/schemas/domaincommon.rng
- add schema grammar for the new element and documentation
*src/conf/domain_conf.c
*src/conf/domain_conf.h
- add field to hold the new attribute
- add code to parse and create XML with the new attribute
---
Changes to v1:
- use a new element <title> in the XML instead of attribute to domain
- Tweaked commit message
- Tweaked docs
- Added restrictions into the RNG grammar for the new element
- Added tests! (hopefuly right)
docs/formatdomain.html.in | 6 ++++
docs/schemas/domaincommon.rng | 13 +++++++++-
src/conf/domain_conf.c | 19 ++++++++++++++
src/conf/domain_conf.h | 1 +
.../qemu-simple-description-title.xml | 27 ++++++++++++++++++++
tests/qemuxml2argvdata/qemuxml2argv-minimal.xml | 5 +++
6 files changed, 70 insertions(+), 1 deletions(-)
create mode 100644 tests/domainschemadata/qemu-simple-description-title.xml
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index de9b480..2945868 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -33,6 +33,7 @@
<name>fv0</name>
<uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
<description>Some human readable description</description>
+ <title>A short description - title - of the domain</title>
...</pre>
<dl>
@@ -59,6 +60,11 @@
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>
+
+ <dt><code>title</code></dt>
+ <dd>The optional element <code>title</code> provides space for a
+ shorter description, capped at 40 bytes and with no newline,
+ <span class="since">since 0.9.10</span>.</dd>
</dl>
<h3><a name="elementsOS">Operating system
booting</a></h3>
diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng
index 2041dfb..bd40e42 100644
--- a/docs/schemas/domaincommon.rng
+++ b/docs/schemas/domaincommon.rng
@@ -6,7 +6,7 @@
<include href='networkcommon.rng'/>
<!--
- description element, may be placed anywhere under the root
+ description and title element, may be placed anywhere under the root
-->
<define name="description">
<element name="description">
@@ -14,6 +14,14 @@
</element>
</define>
+ <define name="title">
+ <element name="title">
+ <data type="string">
+ <param name='pattern'>[^\n]{0,40}</param>
+ </data>
+ </element>
+ </define>
+
<!--
We handle only document defining a domain
-->
@@ -26,6 +34,9 @@
<ref name="description"/>
</optional>
<optional>
+ <ref name="title"/>
+ </optional>
+ <optional>
<ref name="cpu"/>
</optional>
<optional>
diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c
index f97014e..c04a4c0 100644
--- a/src/conf/domain_conf.c
+++ b/src/conf/domain_conf.c
@@ -1478,6 +1478,7 @@ void virDomainDefFree(virDomainDefPtr def)
VIR_FREE(def->cpumask);
VIR_FREE(def->emulator);
VIR_FREE(def->description);
+ VIR_FREE(def->title);
virBlkioDeviceWeightArrayClear(def->blkio.devices,
def->blkio.ndevices);
@@ -7090,6 +7091,22 @@ static virDomainDefPtr virDomainDefParseXML(virCapsPtr caps,
VIR_FREE(tmp);
}
+ /* Extract short description of domain (title) */
+ def->title = virXPathString("string(./title[1])", ctxt);
+ if (def->title) {
+ if (strchr(def->title, '\n')) {
+ virDomainReportError(VIR_ERR_XML_ERROR,
+ "%s", _("Domain title can't contain
newlines"));
+ goto error;
+ }
+
+ if (strlen(def->title) > 40) {
+ virDomainReportError(VIR_ERR_XML_ERROR,
+ "%s", _("Domain title too long"));
+ goto error;
+ }
+ }
+
/* Extract documentation if present */
def->description = virXPathString("string(./description[1])", ctxt);
@@ -11420,6 +11437,8 @@ virDomainDefFormatInternal(virDomainDefPtr def,
virBufferEscapeString(buf, "
<description>%s</description>\n",
def->description);
+ virBufferEscapeString(buf, " <title>%s</title>\n",
def->title);
+
virBufferAsprintf(buf, " <memory>%lu</memory>\n",
def->mem.max_balloon);
virBufferAsprintf(buf, "
<currentMemory>%lu</currentMemory>\n",
def->mem.cur_balloon);
diff --git a/src/conf/domain_conf.h b/src/conf/domain_conf.h
index b121f9c..cbaa2df 100644
--- a/src/conf/domain_conf.h
+++ b/src/conf/domain_conf.h
@@ -1420,6 +1420,7 @@ struct _virDomainDef {
int id;
unsigned char uuid[VIR_UUID_BUFLEN];
char *name;
+ char *title;
char *description;
struct {
diff --git a/tests/domainschemadata/qemu-simple-description-title.xml
b/tests/domainschemadata/qemu-simple-description-title.xml
new file mode 100644
index 0000000..a8a9cac
--- /dev/null
+++ b/tests/domainschemadata/qemu-simple-description-title.xml
@@ -0,0 +1,27 @@
+<domain type='qemu'>
+ <name>qemu-demo</name>
+ <uuid>603cc28c-9841-864e-0949-8cc7d3bae9f8</uuid>
+ <memory>65536</memory>
+ <currentMemory>65536</currentMemory>
+ <title>A short description of this domain</title>
+ <description>
+ A longer explanation that this domain is a test domain
+ for validating domain schemas.
+ </description>
+ <vcpu>1</vcpu>
+ <os>
+ <type arch='x86_64' machine='pc-0.14'>hvm</type>
+ </os>
+ <features>
+ <acpi/>
+ <apic/>
+ <pae/>
+ </features>
+ <clock offset='utc'/>
+ <on_poweroff>destroy</on_poweroff>
+ <on_reboot>restart</on_reboot>
+ <on_crash>restart</on_crash>
+ <devices>
+ <emulator>/usr/bin/qemu-kvm</emulator>
+ </devices>
+</domain>
diff --git a/tests/qemuxml2argvdata/qemuxml2argv-minimal.xml
b/tests/qemuxml2argvdata/qemuxml2argv-minimal.xml
index 2f13d46..6cb0b31 100644
--- a/tests/qemuxml2argvdata/qemuxml2argv-minimal.xml
+++ b/tests/qemuxml2argvdata/qemuxml2argv-minimal.xml
@@ -1,6 +1,11 @@
<domain type='qemu'>
<name>QEMUGuest1</name>
<uuid>c7a5fdbd-edaf-9455-926a-d65c16db1809</uuid>
+ <description>
+ A test of qemu's minimal configuration.
+ This test also tests the description and title elements.
+ </description>
+ <title>A description of the test machine.</title>
<memory>219100</memory>
<currentMemory>219100</currentMemory>
<vcpu cpuset='1-4,8-20,525'>1</vcpu>
--
1.7.3.4