From nobody Fri May 16 15:18:32 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1494598994109937.7136558508654; Fri, 12 May 2017 07:23:14 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 9D5507AEA2; Fri, 12 May 2017 14:23:11 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 6257F58883; Fri, 12 May 2017 14:23:11 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 0169D4EBDA; Fri, 12 May 2017 14:23:11 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id v4CEN03G021126 for ; Fri, 12 May 2017 10:23:00 -0400 Received: by smtp.corp.redhat.com (Postfix) id E41B07FCD7; Fri, 12 May 2017 14:23:00 +0000 (UTC) Received: from mx1.redhat.com (ext-mx05.extmail.prod.ext.phx2.redhat.com [10.5.110.29]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DD1709655D for ; Fri, 12 May 2017 14:23:00 +0000 (UTC) Received: from relay.sw.ru (mailhub.sw.ru [195.214.232.25]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 9841C15552 for ; Fri, 12 May 2017 14:22:58 +0000 (UTC) Received: from dim-vz7.qa.sw.ru (msk-vpn.virtuozzo.com [195.214.232.6]) by relay.sw.ru (8.13.4/8.13.4) with ESMTP id v4CDbfTj007950; Fri, 12 May 2017 16:37:41 +0300 (MSK) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 9D5507AEA2 Authentication-Results: ext-mx01.extmail.prod.ext.phx2.redhat.com; dmarc=fail (p=none dis=none) header.from=virtuozzo.com Authentication-Results: ext-mx01.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=libvir-list-bounces@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 9D5507AEA2 DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 9841C15552 Authentication-Results: ext-mx05.extmail.prod.ext.phx2.redhat.com; dmarc=pass (p=none dis=none) header.from=virtuozzo.com Authentication-Results: ext-mx05.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=nshirokovskiy@virtuozzo.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 9841C15552 From: Nikolay Shirokovskiy To: libvir-list@redhat.com Date: Fri, 12 May 2017 16:37:28 +0300 Message-Id: <1494596248-446694-13-git-send-email-nshirokovskiy@virtuozzo.com> In-Reply-To: <1494596248-446694-1-git-send-email-nshirokovskiy@virtuozzo.com> References: <1494596248-446694-1-git-send-email-nshirokovskiy@virtuozzo.com> X-Greylist: Delayed for 00:44:58 by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]); Fri, 12 May 2017 14:22:59 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]); Fri, 12 May 2017 14:22:59 +0000 (UTC) for IP:'195.214.232.25' DOMAIN:'mailhub.sw.ru' HELO:'relay.sw.ru' FROM:'nshirokovskiy@virtuozzo.com' RCPT:'' X-RedHat-Spam-Score: 0.799 (BAYES_50, SPF_PASS) 195.214.232.25 mailhub.sw.ru 195.214.232.25 mailhub.sw.ru X-Scanned-By: MIMEDefang 2.78 on 10.5.110.29 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com Cc: Dmitry Mishin Subject: [libvirt] [PATCH v2 RFC 12/12] docs: add backup html docs X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.25]); Fri, 12 May 2017 14:23:12 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" --- 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 =3D \ 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 =20 apipng =3D \ @@ -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 =3D { "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 definition= s", + "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 =3D { "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 lib= rary", "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 @@ domain capabilities, node devices, secrets, - snapshots + snapshots, + backups =20
URI format
The URI formats used for connecting to libvirt
@@ -95,6 +96,7 @@ common, domain, domain sna= pshot, + domain backu= p, error, event, host, 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 @@
  • Node devices
  • Secrets
  • Snapshots
    • +
  • Backups
    • =20

    Command line validation

    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 @@ + + + + +

    Backup XML format

    + + 
    
+  
+    
+  
+  
+    
+  
+]]>
    + +

    Backup xml specifies disks to be backed up. It is supported only by= QEMU.

    + +
    +
    disk
    +
    Specifies single disk backup. +
    +
    name
    +
    Mandatory attribute. It identifies the disk either by + <target dev=3D'name'/> or unambiguously by + <source file=3D'name'/> among domain + disk devices. + +
    type
    +
    Optional attribute. Possible values are file and + block. Default value is file. This ele= ment + specifies backup target backend type which is described further + in target child element. +
    +
    +
    + +
    target
    +
    Specifies disk backup target backend. +
    +
    file
    +
    This attribute is taken into account if parent element's type + attribute has value file and specifies absolute pat= h to the backup + file.
    + +
    dev
    +
    This attribute is taken into account if parent element's type + has value block and specifies absolute path to the + backup device.
    + +
    format
    +
    Optional attribute that specifies the backup format. If ommi= tted + the backup format will be the same as the disk format.
    +
    +
    +
    + + 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 @@ domain capabili= ties, node devices, secrets, - snapshots + snapshots, + backups
    Wiki
    Read further community contributed content
    --=20 1.8.3.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list