8:37 a.m.
---
docs/Makefile.am | 3 +++
docs/apibuild.py | 2 ++
docs/docs.html.in | 4 +++-
docs/format.html.in | 1 +
docs/formatbackup.html.in | 58 +++++++++++++++++++++++++++++++++++++++++++++++
docs/index.html.in | 3 ++-
6 files changed, 69 insertions(+), 2 deletions(-)
create mode 100644 docs/formatbackup.html.in
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 7a10a50..98c1191 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -35,6 +35,7 @@ apihtml_generated = \
html/libvirt-libvirt-secret.html \
html/libvirt-libvirt-storage.html \
html/libvirt-libvirt-stream.html \
+ html/libvirt-libvirt-domain-backup.html \
html/libvirt-virterror.html
apipng = \
@@ -341,6 +342,7 @@ $(APIBUILD_STAMP): $(srcdir)/apibuild.py \
$(top_srcdir)/include/libvirt/libvirt-lxc.h \
$(top_srcdir)/include/libvirt/libvirt-qemu.h \
$(top_srcdir)/include/libvirt/libvirt-admin.h \
+ $(top_srcdir)/include/libvirt/libvirt-domain-backup.h \
$(top_srcdir)/include/libvirt/virterror.h \
$(top_srcdir)/src/libvirt.c \
$(top_srcdir)/src/libvirt-domain-snapshot.c \
@@ -356,6 +358,7 @@ $(APIBUILD_STAMP): $(srcdir)/apibuild.py \
$(top_srcdir)/src/libvirt-lxc.c \
$(top_srcdir)/src/libvirt-qemu.c \
$(top_srcdir)/src/libvirt-admin.c \
+ $(top_srcdir)/src/libvirt-domain-backup.c \
$(top_srcdir)/src/util/virerror.c \
$(top_srcdir)/src/util/virevent.c \
$(top_srcdir)/src/util/virtypedparam.c
diff --git a/docs/apibuild.py b/docs/apibuild.py
index 47f340c..9d8fd75 100755
--- a/docs/apibuild.py
+++ b/docs/apibuild.py
@@ -24,6 +24,7 @@ included_files = {
"libvirt-common.h": "header with general libvirt API definitions",
"libvirt-domain.h": "header with general libvirt API definitions",
"libvirt-domain-snapshot.h": "header with general libvirt API
definitions",
+ "libvirt-domain-backup.h": "header with general libvirt API
definitions",
"libvirt-event.h": "header with general libvirt API definitions",
"libvirt-host.h": "header with general libvirt API definitions",
"libvirt-interface.h": "header with general libvirt API
definitions",
@@ -37,6 +38,7 @@ included_files = {
"libvirt.c": "Main interfaces for the libvirt library",
"libvirt-domain.c": "Domain interfaces for the libvirt library",
"libvirt-domain-snapshot.c": "Domain snapshot interfaces for the libvirt
library",
+ "libvirt-domain-backup.c": "Domain backup interfaces for the libvirt
library",
"libvirt-host.c": "Host interfaces for the libvirt library",
"libvirt-interface.c": "Interface interfaces for the libvirt
library",
"libvirt-network.c": "Network interfaces for the libvirt library",
diff --git a/docs/docs.html.in b/docs/docs.html.in
index 60489a0..76eb97e 100644
--- a/docs/docs.html.in
+++ b/docs/docs.html.in
@@ -77,7 +77,8 @@
<a href="formatdomaincaps.html">domain capabilities</a>,
<a href="formatnode.html">node devices</a>,
<a href="formatsecret.html">secrets</a>,
- <a href="formatsnapshot.html">snapshots</a></dd>
+ <a href="formatsnapshot.html">snapshots</a>,
+ <a href="formatbackup.html">backups</a></dd>
<dt><a href="uri.html">URI format</a></dt>
<dd>The URI formats used for connecting to libvirt</dd>
@@ -95,6 +96,7 @@
<a href="html/libvirt-libvirt-common.html">common</a>,
<a href="html/libvirt-libvirt-domain.html">domain</a>,
<a href="html/libvirt-libvirt-domain-snapshot.html">domain
snapshot</a>,
+ <a href="html/libvirt-libvirt-domain-backup.html">domain
backup</a>,
<a href="html/libvirt-virterror.html">error</a>,
<a href="html/libvirt-libvirt-event.html">event</a>,
<a href="html/libvirt-libvirt-host.html">host</a>,
diff --git a/docs/format.html.in b/docs/format.html.in
index 41211a9..39fca5a 100644
--- a/docs/format.html.in
+++ b/docs/format.html.in
@@ -24,6 +24,7 @@
<li><a href="formatnode.html" shape="rect">Node
devices</a></li>
<li><a href="formatsecret.html"
shape="rect">Secrets</a></li>
<li><a href="formatsnapshot.html"
shape="rect">Snapshots</a></li>
+ <li><a href="formatbackup.html"
shape="rect">Backups</a></li>
</ul>
<h2>Command line validation</h2>
diff --git a/docs/formatbackup.html.in b/docs/formatbackup.html.in
new file mode 100644
index 0000000..07c7397
--- /dev/null
+++ b/docs/formatbackup.html.in
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <body>
+ <h1>Backup XML format</h1>
+
+ <pre><![CDATA[
+<domainbackup>
+ <disk name="sda" type="file">
+ <target file="/path/to/backup/file.qcow2" format="qcow2"/>
+ </disk>
+ <disk name="sdb" type="block">
+ <target file="/path/to/backup/dev"/>
+ </disk>
+</domainbackup>]]></pre>
+
+ <p>Backup xml specifies disks to be backed up. It is supported only by
QEMU.</p>
+
+ <dl>
+ <dt><code>disk</code></dt>
+ <dd>Specifies single disk backup.
+ <dl>
+ <dt><code>name</code></dt>
+ <dd>Mandatory attribute. It identifies the disk either by
+ <code><target dev='name'/></code> or
unambiguously by
+ <code><source file='name'/></code> among
domain
+ <a href="formatdomain.html#elementsDisks">disk
devices</a>.</dd>
+
+ <dt><code>type</code></dt>
+ <dd>Optional attribute. Possible values are <code>file</code>
and
+ <code>block</code>. Default value is <code>file</code>.
This element
+ specifies backup target backend type which is described further
+ in <code>target</code> child element.
+ </dd>
+ </dl>
+ </dd>
+
+ <dt><code>target</code></dt>
+ <dd>Specifies disk backup target backend.
+ <dl>
+ <dt><code>file</code></dt>
+ <dd>This attribute is taken into account if parent element's
<code>type</code>
+ attribute has value <code>file</code> and specifies absolute path
to the backup
+ file.</dd>
+
+ <dt><code>dev</code></dt>
+ <dd>This attribute is taken into account if parent element's
<code>type</code>
+ has value <code>block</code> and specifies absolute path to the
+ backup device.</dd>
+
+ <dt><code>format</code></dt>
+ <dd>Optional attribute that specifies the backup format. If ommitted
+ the backup format will be the same as the disk format.</dd>
+ </dl>
+ </dd>
+ </dl>
+ </body>
+</html>
diff --git a/docs/index.html.in b/docs/index.html.in
index 31bd6e0..fbae864 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -68,7 +68,8 @@
<a href="formatdomaincaps.html" shape="rect">domain
capabilities</a>,
<a href="formatnode.html" shape="rect">node
devices</a>,
<a href="formatsecret.html"
shape="rect">secrets</a>,
- <a href="formatsnapshot.html"
shape="rect">snapshots</a></dd>
+ <a href="formatsnapshot.html"
shape="rect">snapshots</a>,
+ <a href="formatbackup.html"
shape="rect">backups</a></dd>
<dt><a
href="http://wiki.libvirt.org">Wiki</a></dt>
<dd>Read further community contributed content</dd>
</dl>
--
1.8.3.1