2005-12-02 01:16:36 +03:00
## Process this file with automake to produce Makefile.in
2011-07-28 22:56:24 +04:00
2016-01-10 23:14:33 +03:00
## Copyright (C) 2005-2016 Red Hat, Inc.
2013-05-15 03:42:12 +04:00
##
## This library is free software; you can redistribute it and/or
## modify it under the terms of the GNU Lesser General Public
## License as published by the Free Software Foundation; either
## version 2.1 of the License, or (at your option) any later version.
##
## This library is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## Lesser General Public License for more details.
##
## You should have received a copy of the GNU Lesser General Public
## License along with this library. If not, see
## <http://www.gnu.org/licenses/>.
2011-07-28 22:56:24 +04:00
2019-05-10 17:22:11 +03:00
HTML_DIR = $( docdir) /html
2009-10-02 15:29:15 +04:00
2019-05-10 15:48:46 +03:00
modules = \
libvirt-common \
libvirt-domain \
backup: Introduce virDomainCheckpoint APIs
Introduce a bunch of new public APIs related to backup checkpoints.
Checkpoints are modeled heavily after virDomainSnapshotPtr (both
represent a point in time of the guest), although a snapshot exists
with the intent of rolling back to that state, while a checkpoint
exists to make it possible to create an incremental backup at a later
time. We may have a future hypervisor that can completely manage
checkpoints without libvirt metadata, but the first two planned
hypervisors (qemu and test) both always use libvirt for tracking
metadata relations between checkpoints, so for now, I've deferred
the counterpart of virDomainSnapshotHasMetadata for a separate
API addition at a later date if there is ever a need for it.
Note that until we allow snapshots and checkpoints to exist
simultaneously on the same domain (although the actual prevention of
this will be in a separate patch for the sake of an easier revert down
the road), that it is not possible to branch out to create more than
one checkpoint child to a given parent, although it may become
possible later when we revert to a snapshot that coincides with a
checkpoint. This also means that for now, the decision of which
checkpoint becomes the parent of a newly created one is the only
checkpoint with no child (so while there are APIs for dealing with a
current snapshot, we do not need those for checkpoints). We may end
up exposing a notion of a current checkpoint later, but it's easier to
add stuff when proven needed than to blindly support it now and wish
we hadn't exposed it.
The following map shows the API relations to snapshots, with new APIs
on the right:
Operate on a domain object to create/redefine a child:
virDomainSnapshotCreateXML virDomainCheckpointCreateXML
Operate on a child object for lifetime management:
virDomainSnapshotDelete virDomainCheckpointDelete
virDomainSnapshotFree virDomainCheckpointFree
virDomainSnapshotRef virDomainCheckpointRef
Operate on a child object to learn more about it:
virDomainSnapshotGetXMLDesc virDomainCheckpointGetXMLDesc
virDomainSnapshotGetConnect virDomainCheckpointGetConnect
virDomainSnapshotGetDomain virDomainCheckpointGetDomain
virDomainSnapshotGetName virDomainCheckpiontGetName
virDomainSnapshotGetParent virDomainCheckpiontGetParent
virDomainSnapshotHasMetadata (deferred for later)
virDomainSnapshotIsCurrent (no counterpart, see note above)
Operate on a domain object to list all children:
virDomainSnapshotNum (no counterparts, these are the old
virDomainSnapshotListNames racy interfaces)
virDomainSnapshotListAllSnapshots virDomainListAllCheckpoints
Operate on a child object to list descendents:
virDomainSnapshotNumChildren (no counterparts, these are the old
virDomainSnapshotListChildrenNames racy interfaces)
virDomainSnapshotListAllChildren virDomainCheckpointListAllChildren
Operate on a domain to locate a particular child:
virDomainSnapshotLookupByName virDomainCheckpointLookupByName
virDomainSnapshotCurrent (no counterpart, see note above)
virDomainHasCurrentSnapshot (no counterpart, old racy interface)
Operate on a snapshot to roll back to earlier state:
virDomainSnapshotRevert (no counterpart, instead checkpoints
are used in incremental backups via
XML to virDomainBackupBegin)
Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2019-03-13 22:35:26 +03:00
libvirt-domain-checkpoint \
2019-05-10 15:48:46 +03:00
libvirt-domain-snapshot \
libvirt-event \
libvirt-host \
libvirt-interface \
libvirt-network \
libvirt-nodedev \
libvirt-nwfilter \
libvirt-secret \
libvirt-storage \
libvirt-stream \
virterror \
$( NULL)
2019-11-20 17:49:26 +03:00
modules_admin = libvirt-admin
modules_qemu = libvirt-qemu
modules_lxc = libvirt-lxc
2019-11-20 18:17:22 +03:00
all : vpathhack
# This hack enables us to view the web pages
# from within the uninstalled build tree
vpathhack :
@for dir in fonts js logos; \
do \
test -e $$ dir || ln -s $( srcdir) /$$ dir $$ dir ; \
done
2020-04-16 14:41:52 +03:00
@for file in $( assets) ; \
2019-11-20 18:17:22 +03:00
do \
test -e $$ file || ln -s $( srcdir) /$$ file $$ file ; \
done
clean-local :
for dir in fonts js logos; \
do \
rm -f $$ dir ; \
done
2020-04-16 14:41:52 +03:00
for file in $( assets) ; \
2019-11-20 18:17:22 +03:00
do \
rm -f $$ file ; \
done
2017-11-03 15:09:47 +03:00
apihtml = \
html/index.html \
2014-12-02 09:50:18 +03:00
$( apihtml_generated)
apihtml_generated = \
2019-05-10 15:48:46 +03:00
$( addprefix html/libvirt-,$( addsuffix .html,$( modules) ) ) \
$( NULL)
2007-11-15 16:04:28 +03:00
2019-11-20 17:49:26 +03:00
apiadminhtml = \
html/index-admin.html \
$( apiadminhtml_generated)
apiadminhtml_generated = \
$( addprefix html/libvirt-,$( addsuffix .html,$( modules_admin) ) ) \
$( NULL)
apiqemuhtml = \
html/index-qemu.html \
$( apiqemuhtml_generated)
apiqemuhtml_generated = \
$( addprefix html/libvirt-,$( addsuffix .html,$( modules_qemu) ) ) \
$( NULL)
apilxchtml = \
html/index-lxc.html \
$( apilxchtml_generated)
apilxchtml_generated = \
$( addprefix html/libvirt-,$( addsuffix .html,$( modules_lxc) ) ) \
$( NULL)
2017-11-03 15:09:47 +03:00
apipng = \
html/left.png \
html/up.png \
html/home.png \
2008-04-28 12:29:35 +04:00
html/right.png
2007-11-15 16:04:28 +03:00
2019-11-20 17:23:04 +03:00
apirefdir = $( HTML_DIR) /html
2019-11-20 17:49:26 +03:00
apiref_DATA = $( apihtml) $( apiadminhtml) $( apiqemuhtml) $( apilxchtml) $( apipng)
2019-11-20 17:23:04 +03:00
2019-04-05 17:43:07 +03:00
javascript = \
2019-04-05 15:59:31 +03:00
js/main.js \
2019-06-19 17:49:15 +03:00
$( NULL)
2019-04-05 17:43:07 +03:00
2019-11-20 17:23:04 +03:00
javascriptdir = $( HTML_DIR) /js
javascript_DATA = $( javascript)
2017-05-11 12:01:27 +03:00
fonts = \
2020-04-14 13:59:04 +03:00
fonts/LICENSE.rst \
2017-05-11 12:01:27 +03:00
fonts/stylesheet.css \
fonts/overpass-bold-italic.woff \
fonts/overpass-bold.woff \
fonts/overpass-italic.woff \
fonts/overpass-light-italic.woff \
fonts/overpass-light.woff \
fonts/overpass-mono-bold.woff \
fonts/overpass-mono-light.woff \
fonts/overpass-mono-regular.woff \
fonts/overpass-mono-semibold.woff \
fonts/overpass-regular.woff
2019-11-20 17:23:04 +03:00
fontsdir = $( HTML_DIR) /fonts
fonts_DATA = $( fonts)
2016-10-31 15:20:53 +03:00
logofiles = \
logos/logo-base.svg \
logos/logo-square.svg \
logos/logo-square-powered.svg \
logos/logo-banner-dark.svg \
logos/logo-banner-light.svg \
logos/logo-square-96.png \
logos/logo-square-128.png \
logos/logo-square-192.png \
logos/logo-square-256.png \
logos/logo-square-powered-96.png \
logos/logo-square-powered-128.png \
logos/logo-square-powered-192.png \
logos/logo-square-powered-256.png \
logos/logo-banner-dark-256.png \
logos/logo-banner-dark-800.png \
logos/logo-banner-light-256.png \
logos/logo-banner-light-800.png
2019-11-20 17:23:04 +03:00
logofilesdir = $( HTML_DIR) /logos
logofiles_DATA = $( logofiles)
2020-04-16 14:41:52 +03:00
assets = \
2020-04-16 14:49:29 +03:00
android-chrome-192x192.png \
android-chrome-256x256.png \
apple-touch-icon.png \
2020-04-16 14:41:52 +03:00
architecture.gif \
2020-04-16 14:49:29 +03:00
browserconfig.xml \
favicon.ico \
favicon-16x16.png \
favicon-32x32.png \
2020-04-16 14:41:52 +03:00
generic.css \
libvirt.css \
2009-04-16 00:42:50 +04:00
libvirt-daemon-arch.png \
libvirt-driver-arch.png \
libvirt-object-model.png \
2020-04-16 14:49:29 +03:00
libvirt-virConnect-example.png \
2020-04-16 14:41:52 +03:00
main.css \
2020-04-16 14:49:29 +03:00
manifest.json \
Add documentation about migration.
This adds a page documenting many aspects of migration:
- The types of migration (managed direct, p2p, unmanaged direct)
- Data transports (native, tunnelled)
- Migration URIs
- Config file handling
- Example scenarios
* libvirt.css: Rules for data tables and diagrams
* Makefile.am: Include extra png/fig files
* migration-managed-direct.fig, migration-managed-direct.png,
migration-managed-direct.png, migration-managed-p2p.png,
migration-native.fig, migration-native.png,
migration-tunnel.fig, migration-tunnel.png,
migration-unmanaged-direct.fig, migration-unmanaged-direct.png:
Diagrams of migration
* migration.html.in, sitemap.html.in: New migration doc
2009-10-02 20:53:51 +04:00
migration-managed-direct.png \
migration-managed-p2p.png \
migration-native.png \
migration-tunnel.png \
2020-04-16 14:41:52 +03:00
migration-unmanaged-direct.png \
mobile.css \
2020-04-16 14:49:29 +03:00
mstile-150x150.png \
2020-04-16 14:41:52 +03:00
node.gif \
$( NULL)
2007-11-15 16:04:28 +03:00
2012-10-21 04:29:47 +04:00
internals_html_in = \
$( patsubst $( srcdir) /%,%,$( wildcard $( srcdir) /internals/*.html.in) )
2019-12-06 20:26:18 +03:00
internals_rst = \
$( patsubst $( srcdir) /%,%,$( wildcard $( srcdir) /internals/*.rst) )
internals_rst_html_in = \
$( internals_rst:%.rst= %.html.in)
2019-10-18 16:18:36 +03:00
internals_html = \
$( internals_html_in:%.html.in= %.html) \
$( internals_rst_html_in:%.html.in= %.html)
2012-10-21 04:29:47 +04:00
2019-11-20 17:23:04 +03:00
internalsdir = $( HTML_DIR) /internals
internals_DATA = $( internals_html)
2019-07-08 15:58:56 +03:00
kbase_html_in = \
$( patsubst $( srcdir) /%,%,$( wildcard $( srcdir) /kbase/*.html.in) )
2019-10-18 16:18:36 +03:00
kbase_rst = \
$( patsubst $( srcdir) /%,%,$( wildcard $( srcdir) /kbase/*.rst) )
kbase_rst_html_in = \
$( kbase_rst:%.rst= %.html.in)
kbase_html = \
$( kbase_html_in:%.html.in= %.html) \
$( kbase_rst_html_in:%.html.in= %.html)
2019-07-08 15:58:56 +03:00
2019-11-20 17:23:04 +03:00
kbasedir = $( HTML_DIR) /kbase
kbase_DATA = $( kbase_html)
2019-10-18 17:29:47 +03:00
# Sync with src/util/
KEYCODES = linux osx atset1 atset2 atset3 xtkbd usb win32 qnum
KEYNAMES = linux osx win32
2019-10-18 16:18:36 +03:00
manpages_rst = \
manpages/index.rst \
$( NULL)
manpages1_rst = \
2019-10-18 17:29:47 +03:00
manpages/virt-pki-validate.rst \
2019-10-18 17:29:47 +03:00
manpages/virt-xml-validate.rst \
2019-10-18 17:29:47 +03:00
manpages/virt-admin.rst \
2019-10-18 17:29:47 +03:00
manpages/virsh.rst \
2019-10-18 16:18:36 +03:00
$( NULL)
manpages7_rst = \
2019-10-18 17:29:47 +03:00
$( KEYCODES:%= manpages/virkeycode-%.rst) \
$( KEYNAMES:%= manpages/virkeyname-%.rst) \
2019-10-18 16:18:36 +03:00
$( NULL)
2019-12-18 22:46:16 +03:00
manpages8_rst = $( NULL)
2019-10-18 16:18:36 +03:00
manpages_rst += \
$( manpages1_rst) \
$( manpages7_rst) \
$( manpages8_rst) \
$( NULL)
2019-10-18 17:29:47 +03:00
i f W I T H _ L I B V I R T D
manpages8_rst += \
manpages/libvirtd.rst \
2019-10-18 17:29:47 +03:00
manpages/virtlockd.rst \
2019-10-18 17:29:47 +03:00
manpages/virtlogd.rst \
2019-10-18 17:29:47 +03:00
$( NULL)
e l s e ! W I T H _ L I B V I R T D
manpages_rst += \
manpages/libvirtd.rst \
2019-10-18 17:29:47 +03:00
manpages/virtlockd.rst \
2019-10-18 17:29:47 +03:00
manpages/virtlogd.rst \
2019-10-18 17:29:47 +03:00
$( NULL)
e n d i f ! W I T H _ L I B V I R T D
2019-10-18 17:29:47 +03:00
i f W I T H _ H O S T _ V A L I D A T E
manpages1_rst += manpages/virt-host-validate.rst
e l s e ! W I T H _ H O S T _ V A L I D A T E
manpages_rst += manpages/virt-host-validate.rst
e n d i f ! W I T H _ H O S T _ V A L I D A T E
2019-10-18 17:29:47 +03:00
i f W I T H _ L O G I N _ S H E L L
manpages1_rst += manpages/virt-login-shell.rst
e l s e ! W I T H _ L O G I N _ S H E L L
manpages_rst += manpages/virt-login-shell.rst
e n d i f ! W I T H _ L O G I N _ S H E L L
2019-12-18 22:46:16 +03:00
i f W I T H _ S A N L O C K
manpages8_rst += manpages/virt-sanlock-cleanup.rst
e l s e ! W I T H _ S A N L O C K
manpages_rst += manpages/virt-sanlock-cleanup.rst
e n d i f ! W I T H _ S A N L O C K
2019-05-17 15:01:59 +03:00
i f W I T H _ Q E M U
manpages1_rst += manpages/virt-qemu-run.rst
e l s e ! W I T H _ Q E M U
manpages_rst += manpages/virt-qemu-run.rst
e n d i f ! W I T H _ Q E M U
2019-10-18 16:18:36 +03:00
manpages_rst_html_in = \
$( manpages_rst:%.rst= %.html.in)
manpages_html = \
$( manpages_rst_html_in:%.html.in= %.html)
man1_MANS = $( manpages1_rst:%.rst= %.1)
man7_MANS = $( manpages7_rst:%.rst= %.7)
man8_MANS = $( manpages8_rst:%.rst= %.8)
%.1 : %.rst
$( AM_V_GEN) $( MKDIR_P) ` dirname $@ ` && \
grep -v '^\.\. contents::' < $< | \
sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \
-e 's|RUNSTATEDIR|$(runstatedir)|g' | \
2020-01-29 13:17:45 +03:00
$( RST2MAN) --strict > $@ || { rm $@ && exit 1; }
2019-10-18 16:18:36 +03:00
%.7 : %.rst
$( AM_V_GEN) $( MKDIR_P) ` dirname $@ ` && \
grep -v '^\.\. contents::' < $< | \
sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \
-e 's|RUNSTATEDIR|$(runstatedir)|g' | \
2020-01-29 13:17:45 +03:00
$( RST2MAN) --strict > $@ || { rm $@ && exit 1; }
2019-10-18 16:18:36 +03:00
%.8 : %.rst
$( AM_V_GEN) $( MKDIR_P) ` dirname $@ ` && \
grep -v '^\.\. contents::' < $< | \
sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \
-e 's|RUNSTATEDIR|$(runstatedir)|g' | \
2020-01-29 13:17:45 +03:00
$( RST2MAN) --strict > $@ || { rm $@ && exit 1; }
2019-10-18 16:18:36 +03:00
2019-10-18 17:29:47 +03:00
manpages/virkeycode-%.rst : $( top_srcdir ) /src /keycodemapdb /data /keymaps .csv \
$( top_srcdir) /src/keycodemapdb/tools/keymap-gen Makefile.am
$( AM_V_GEN) export NAME = ` echo $@ | \
sed -e 's,manpages/virkeycode-,,' -e 's,\.rst,,' ` && \
$( MKDIR_P) manpages/ && \
$( RUNUTF8) $( PYTHON) $( top_srcdir) /src/keycodemapdb/tools/keymap-gen \
code-docs \
--lang rst \
--title " virkeycode- $$ NAME " \
--subtitle " Key code values for $$ NAME " \
$( top_srcdir) /src/keycodemapdb/data/keymaps.csv $$ NAME > $@
manpages/virkeyname-%.rst : $( top_srcdir ) /src /keycodemapdb /data /keymaps .csv \
$( top_srcdir) /src/keycodemapdb/tools/keymap-gen Makefile.am
$( AM_V_GEN) export NAME = ` echo $@ | \
sed -e 's,manpages/virkeyname-,,' -e 's,\.rst,,' ` && \
$( MKDIR_P) manpages/ && \
$( RUNUTF8) $( PYTHON) $( top_srcdir) /src/keycodemapdb/tools/keymap-gen \
name-docs \
--lang rst \
--title " virkeyname- $$ NAME " \
--subtitle " Key name values for $$ NAME " \
$( top_srcdir) /src/keycodemapdb/data/keymaps.csv $$ NAME > $@
2019-10-18 16:18:36 +03:00
manpagesdir = $( HTML_DIR) /manpages
manpages_DATA = $( manpages_html)
2020-06-02 14:44:21 +03:00
# Generate hvsupport.html first, since it takes one extra step.
2019-10-18 18:21:06 +03:00
dot_html_generated_in = \
2016-07-28 11:04:11 +03:00
hvsupport.html.in \
2020-06-02 14:44:21 +03:00
$( NULL)
2019-10-18 18:21:06 +03:00
dot_html_in = \
2016-07-28 11:04:11 +03:00
$( notdir $( wildcard $( srcdir) /*.html.in) )
2019-10-18 16:18:36 +03:00
dot_rst = \
$( notdir $( wildcard $( srcdir) /*.rst) )
dot_rst_html_in = \
2020-06-02 14:44:21 +03:00
$( dot_rst:%.rst= %.html.in) \
news.html.in \
$( NULL)
2019-10-18 18:21:06 +03:00
dot_html = \
$( dot_html_generated_in:%.html.in= %.html) \
2019-10-18 16:18:36 +03:00
$( dot_html_in:%.html.in= %.html) \
$( dot_rst_html_in:%.html.in= %.html)
2007-11-15 16:04:28 +03:00
2019-11-20 17:23:04 +03:00
htmldir = $( HTML_DIR)
2020-04-16 14:41:52 +03:00
html_DATA = $( assets) $( dot_html)
2019-11-20 17:23:04 +03:00
2012-02-13 20:46:29 +04:00
apidir = $( pkgdatadir) /api
2015-04-15 17:23:25 +03:00
api_DATA = \
libvirt-api.xml \
libvirt-qemu-api.xml \
2016-06-24 20:27:09 +03:00
libvirt-lxc-api.xml \
libvirt-admin-api.xml
2012-02-13 20:46:29 +04:00
2020-07-10 18:39:29 +03:00
svg = \
libvirt-daemon-arch.svg \
libvirt-driver-arch.svg \
libvirt-object-model.svg \
migration-managed-direct.svg \
migration-managed-p2p.svg \
migration-native.svg \
migration-tunnel.svg \
migration-unmanaged-direct.svg
2008-04-23 21:08:31 +04:00
2016-01-10 23:14:33 +03:00
schemadir = $( pkgdatadir) /schemas
2016-01-12 18:22:24 +03:00
schema_DATA = $( wildcard $( srcdir) /schemas/*.rng)
2016-01-10 23:14:33 +03:00
2017-11-03 15:09:47 +03:00
EXTRA_DIST = \
2017-01-03 14:22:54 +03:00
site.xsl subsite.xsl newapi.xsl page.xsl \
2020-04-16 14:41:52 +03:00
$( dot_html_in) $( dot_rst) $( apipng) \
2020-07-10 18:39:29 +03:00
$( svg) $( assets) \
2019-04-05 17:43:07 +03:00
$( javascript) $( logofiles) \
2019-10-18 16:18:36 +03:00
$( internals_html_in) $( internals_rst) $( fonts) \
$( kbase_html_in) $( kbase_rst) \
2019-10-18 16:18:36 +03:00
$( manpages_rst) \
2016-10-31 14:25:26 +03:00
aclperms.htmlinc \
2016-01-10 23:14:33 +03:00
$( schema_DATA)
2007-11-15 16:04:28 +03:00
2015-06-26 11:49:19 +03:00
acl_generated = aclperms.htmlinc
2013-08-08 14:51:01 +04:00
2019-10-18 18:21:06 +03:00
aclperms.htmlinc : $( top_srcdir ) /src /access /viraccessperm .h \
2019-08-30 15:22:54 +03:00
$( top_srcdir) /scripts/genaclperms.py Makefile.am
$( AM_V_GEN) $( RUNUTF8) $( PYTHON) $( top_srcdir) /scripts/genaclperms.py $< > $@
2013-08-08 14:51:01 +04:00
2019-10-18 18:21:06 +03:00
CLEANFILES = \
$( dot_html) \
$( apihtml) \
2019-11-20 17:49:26 +03:00
$( apiadminhtml) \
$( apiqemuhtml) \
$( apilxchtml) \
2019-10-18 18:21:06 +03:00
$( internals_html) \
$( kbase_html) \
2019-10-18 16:18:36 +03:00
$( manpages_html) \
$( man1_MANS) \
$( man7_MANS) \
2019-10-18 17:29:47 +03:00
$( manpages7_rst) \
2019-10-18 16:18:36 +03:00
$( man8_MANS) \
2019-11-20 17:37:41 +03:00
$( api_DATA) \
2019-10-18 18:21:06 +03:00
$( dot_html_generated_in) \
aclperms.htmlinc
2009-09-16 21:56:56 +04:00
2017-07-26 18:04:37 +03:00
timestamp = " $( shell if test -n " $$ SOURCE_DATE_EPOCH " ; \
then \
2017-07-28 11:45:26 +03:00
date -u --date= " @ $$ SOURCE_DATE_EPOCH " ; \
2017-07-26 18:04:37 +03:00
else \
2017-07-28 11:45:26 +03:00
date -u; \
2017-07-26 18:04:37 +03:00
fi ) "
2019-10-18 18:21:06 +03:00
hvsupport.html : hvsupport .html .in
2013-08-31 02:05:43 +04:00
2019-08-30 15:22:54 +03:00
hvsupport.html.in : $( top_srcdir ) /scripts /hvsupport .py $( api_DATA ) \
2015-04-27 12:08:59 +03:00
$( top_srcdir) /src/libvirt_public.syms \
$( top_srcdir) /src/libvirt_qemu.syms $( top_srcdir) /src/libvirt_lxc.syms \
$( top_srcdir) /src/driver.h
2019-08-30 15:22:54 +03:00
$( AM_V_GEN) $( RUNUTF8) $( PYTHON) $( top_srcdir) /scripts/hvsupport.py \
$( top_srcdir) $( top_builddir) > $@ || { rm $@ && exit 1; }
2011-05-13 14:00:56 +04:00
2019-10-18 16:18:36 +03:00
manpages/%.html.in : manpages /%.rst
$( AM_V_GEN) $( MKDIR_P) ` dirname $@ ` && \
grep -v '^:Manual ' < $< | \
sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \
-e 's|RUNSTATEDIR|$(runstatedir)|g' | \
2020-01-29 13:17:45 +03:00
$( RST2HTML) --strict > $@ || { rm $@ && exit 1; }
2019-10-18 16:18:36 +03:00
2020-06-02 14:44:21 +03:00
news.html.in : $( top_srcdir ) /NEWS .rst
$( AM_V_GEN) $( MKDIR_P) ` dirname $@ ` && \
$( RST2HTML) --strict $< > $@ || { rm $@ && exit 1; }
CLEANFILES += news.html.in
2019-10-18 16:18:36 +03:00
%.html.in : %.rst
$( AM_V_GEN) $( MKDIR_P) ` dirname $@ ` && \
2020-01-29 13:17:45 +03:00
$( RST2HTML) --strict $< > $@ || { rm $@ && exit 1; }
2019-10-18 16:18:36 +03:00
2016-01-20 18:27:24 +03:00
%.html.tmp : %.html .in site .xsl subsite .xsl page .xsl \
2016-10-31 14:25:26 +03:00
$( acl_generated)
2017-07-26 19:40:44 +03:00
$( AM_V_GEN) name = ` echo $@ | sed -e 's/.tmp//' ` ; \
2020-04-08 18:18:58 +03:00
genhtmlin = ` echo $@ | sed -e 's/.tmp/.in/' ` ; \
rst = ` echo $@ | sed -e 's/.html.tmp/.rst/' ` ; \
src = " $$ genhtmlin " ; \
test -f " $$ genhtmlin " && src = " $$ rst " ; \
2016-01-20 15:22:19 +03:00
dir = ` dirname $@ ` ; \
if test " $$ dir " = "." ; \
then \
style = site.xsl; \
else \
$( MKDIR_P) $$ dir; \
style = subsite.xsl; \
fi ; \
2017-07-26 18:04:37 +03:00
$( XSLTPROC) --stringparam pagename $$ name \
2020-04-08 18:18:58 +03:00
--stringparam pagesrc $$ src \
2019-11-20 18:24:18 +03:00
--stringparam builddir '$(abs_top_builddir)' \
2017-07-26 18:04:37 +03:00
--stringparam timestamp $( timestamp) --nonet \
2016-01-20 15:22:19 +03:00
$( top_srcdir) /docs/$$ style $< > $@ \
2017-07-26 19:40:44 +03:00
|| { rm $@ && exit 1; }
2008-04-23 21:08:31 +04:00
%.html : %.html .tmp
2019-10-18 18:21:06 +03:00
$( AM_V_GEN) $( XMLLINT) --nonet --format $< > $@ \
|| { rm $@ && exit 1; }
2005-12-02 01:16:36 +03:00
2014-12-02 09:50:18 +03:00
$(apihtml_generated) : html /index .html
2019-11-20 17:49:26 +03:00
$(apiadminhtml_generated) : html /index -admin .html
$(apiqemuhtml_generated) : html /index -qemu .html
$(apilxchtml_generated) : html /index -lxc .html
2014-12-02 09:50:18 +03:00
2016-12-06 16:38:46 +03:00
html/index.html : libvirt -api .xml newapi .xsl page .xsl $( APIBUILD_STAMP )
2019-10-18 18:21:06 +03:00
$( AM_V_GEN) $( XSLTPROC) --nonet -o ./ \
2013-09-20 13:47:39 +04:00
--stringparam builddir '$(abs_top_builddir)' \
2017-07-26 18:04:37 +03:00
--stringparam timestamp $( timestamp) \
2019-11-27 17:03:45 +03:00
$( srcdir) /newapi.xsl libvirt-api.xml
2005-12-02 01:16:36 +03:00
2019-11-20 17:49:26 +03:00
html/index-%.html : libvirt -%-api .xml newapi .xsl page .xsl $( APIBUILD_STAMP )
$( AM_V_GEN) $( XSLTPROC) --nonet -o ./ \
--stringparam builddir '$(abs_top_builddir)' \
--stringparam timestamp $( timestamp) \
--stringparam indexfile $( @:html/%= %) \
2019-11-27 17:03:45 +03:00
$( srcdir) /newapi.xsl $<
check-html :
$( XMLLINT) --nonet --noout html/*.html
check-local : check -html
2019-11-20 17:49:26 +03:00
2020-06-05 17:47:02 +03:00
python_generated_files = $( api_DATA)
2005-12-02 01:16:36 +03:00
2019-10-08 13:19:30 +03:00
APIBUILD = $( top_srcdir) /scripts/apibuild.py
2019-10-18 18:21:06 +03:00
APIBUILD_STAMP = apibuild.py.stamp
CLEANFILES += $( APIBUILD_STAMP)
2012-04-27 20:05:12 +04:00
$(python_generated_files) : $( APIBUILD_STAMP )
2019-10-08 13:19:30 +03:00
$(APIBUILD_STAMP) : $( top_srcdir ) /scripts /apibuild .py \
2015-11-26 17:02:49 +03:00
$( top_srcdir) /include/libvirt/libvirt.h \
$( top_srcdir) /include/libvirt/libvirt-common.h.in \
backup: Introduce virDomainCheckpoint APIs
Introduce a bunch of new public APIs related to backup checkpoints.
Checkpoints are modeled heavily after virDomainSnapshotPtr (both
represent a point in time of the guest), although a snapshot exists
with the intent of rolling back to that state, while a checkpoint
exists to make it possible to create an incremental backup at a later
time. We may have a future hypervisor that can completely manage
checkpoints without libvirt metadata, but the first two planned
hypervisors (qemu and test) both always use libvirt for tracking
metadata relations between checkpoints, so for now, I've deferred
the counterpart of virDomainSnapshotHasMetadata for a separate
API addition at a later date if there is ever a need for it.
Note that until we allow snapshots and checkpoints to exist
simultaneously on the same domain (although the actual prevention of
this will be in a separate patch for the sake of an easier revert down
the road), that it is not possible to branch out to create more than
one checkpoint child to a given parent, although it may become
possible later when we revert to a snapshot that coincides with a
checkpoint. This also means that for now, the decision of which
checkpoint becomes the parent of a newly created one is the only
checkpoint with no child (so while there are APIs for dealing with a
current snapshot, we do not need those for checkpoints). We may end
up exposing a notion of a current checkpoint later, but it's easier to
add stuff when proven needed than to blindly support it now and wish
we hadn't exposed it.
The following map shows the API relations to snapshots, with new APIs
on the right:
Operate on a domain object to create/redefine a child:
virDomainSnapshotCreateXML virDomainCheckpointCreateXML
Operate on a child object for lifetime management:
virDomainSnapshotDelete virDomainCheckpointDelete
virDomainSnapshotFree virDomainCheckpointFree
virDomainSnapshotRef virDomainCheckpointRef
Operate on a child object to learn more about it:
virDomainSnapshotGetXMLDesc virDomainCheckpointGetXMLDesc
virDomainSnapshotGetConnect virDomainCheckpointGetConnect
virDomainSnapshotGetDomain virDomainCheckpointGetDomain
virDomainSnapshotGetName virDomainCheckpiontGetName
virDomainSnapshotGetParent virDomainCheckpiontGetParent
virDomainSnapshotHasMetadata (deferred for later)
virDomainSnapshotIsCurrent (no counterpart, see note above)
Operate on a domain object to list all children:
virDomainSnapshotNum (no counterparts, these are the old
virDomainSnapshotListNames racy interfaces)
virDomainSnapshotListAllSnapshots virDomainListAllCheckpoints
Operate on a child object to list descendents:
virDomainSnapshotNumChildren (no counterparts, these are the old
virDomainSnapshotListChildrenNames racy interfaces)
virDomainSnapshotListAllChildren virDomainCheckpointListAllChildren
Operate on a domain to locate a particular child:
virDomainSnapshotLookupByName virDomainCheckpointLookupByName
virDomainSnapshotCurrent (no counterpart, see note above)
virDomainHasCurrentSnapshot (no counterpart, old racy interface)
Operate on a snapshot to roll back to earlier state:
virDomainSnapshotRevert (no counterpart, instead checkpoints
are used in incremental backups via
XML to virDomainBackupBegin)
Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2019-03-13 22:35:26 +03:00
$( top_srcdir) /include/libvirt/libvirt-domain-checkpoint.h \
2015-04-27 12:08:59 +03:00
$( top_srcdir) /include/libvirt/libvirt-domain-snapshot.h \
$( top_srcdir) /include/libvirt/libvirt-domain.h \
$( top_srcdir) /include/libvirt/libvirt-event.h \
$( top_srcdir) /include/libvirt/libvirt-host.h \
$( top_srcdir) /include/libvirt/libvirt-interface.h \
$( top_srcdir) /include/libvirt/libvirt-network.h \
$( top_srcdir) /include/libvirt/libvirt-nodedev.h \
$( top_srcdir) /include/libvirt/libvirt-nwfilter.h \
$( top_srcdir) /include/libvirt/libvirt-secret.h \
$( top_srcdir) /include/libvirt/libvirt-storage.h \
$( top_srcdir) /include/libvirt/libvirt-stream.h \
$( top_srcdir) /include/libvirt/libvirt-lxc.h \
$( top_srcdir) /include/libvirt/libvirt-qemu.h \
2015-04-15 17:23:25 +03:00
$( top_srcdir) /include/libvirt/libvirt-admin.h \
2015-04-27 12:08:59 +03:00
$( top_srcdir) /include/libvirt/virterror.h \
$( top_srcdir) /src/libvirt.c \
backup: Introduce virDomainCheckpoint APIs
Introduce a bunch of new public APIs related to backup checkpoints.
Checkpoints are modeled heavily after virDomainSnapshotPtr (both
represent a point in time of the guest), although a snapshot exists
with the intent of rolling back to that state, while a checkpoint
exists to make it possible to create an incremental backup at a later
time. We may have a future hypervisor that can completely manage
checkpoints without libvirt metadata, but the first two planned
hypervisors (qemu and test) both always use libvirt for tracking
metadata relations between checkpoints, so for now, I've deferred
the counterpart of virDomainSnapshotHasMetadata for a separate
API addition at a later date if there is ever a need for it.
Note that until we allow snapshots and checkpoints to exist
simultaneously on the same domain (although the actual prevention of
this will be in a separate patch for the sake of an easier revert down
the road), that it is not possible to branch out to create more than
one checkpoint child to a given parent, although it may become
possible later when we revert to a snapshot that coincides with a
checkpoint. This also means that for now, the decision of which
checkpoint becomes the parent of a newly created one is the only
checkpoint with no child (so while there are APIs for dealing with a
current snapshot, we do not need those for checkpoints). We may end
up exposing a notion of a current checkpoint later, but it's easier to
add stuff when proven needed than to blindly support it now and wish
we hadn't exposed it.
The following map shows the API relations to snapshots, with new APIs
on the right:
Operate on a domain object to create/redefine a child:
virDomainSnapshotCreateXML virDomainCheckpointCreateXML
Operate on a child object for lifetime management:
virDomainSnapshotDelete virDomainCheckpointDelete
virDomainSnapshotFree virDomainCheckpointFree
virDomainSnapshotRef virDomainCheckpointRef
Operate on a child object to learn more about it:
virDomainSnapshotGetXMLDesc virDomainCheckpointGetXMLDesc
virDomainSnapshotGetConnect virDomainCheckpointGetConnect
virDomainSnapshotGetDomain virDomainCheckpointGetDomain
virDomainSnapshotGetName virDomainCheckpiontGetName
virDomainSnapshotGetParent virDomainCheckpiontGetParent
virDomainSnapshotHasMetadata (deferred for later)
virDomainSnapshotIsCurrent (no counterpart, see note above)
Operate on a domain object to list all children:
virDomainSnapshotNum (no counterparts, these are the old
virDomainSnapshotListNames racy interfaces)
virDomainSnapshotListAllSnapshots virDomainListAllCheckpoints
Operate on a child object to list descendents:
virDomainSnapshotNumChildren (no counterparts, these are the old
virDomainSnapshotListChildrenNames racy interfaces)
virDomainSnapshotListAllChildren virDomainCheckpointListAllChildren
Operate on a domain to locate a particular child:
virDomainSnapshotLookupByName virDomainCheckpointLookupByName
virDomainSnapshotCurrent (no counterpart, see note above)
virDomainHasCurrentSnapshot (no counterpart, old racy interface)
Operate on a snapshot to roll back to earlier state:
virDomainSnapshotRevert (no counterpart, instead checkpoints
are used in incremental backups via
XML to virDomainBackupBegin)
Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2019-03-13 22:35:26 +03:00
$( top_srcdir) /src/libvirt-domain-checkpoint.c \
2016-12-06 16:38:46 +03:00
$( top_srcdir) /src/libvirt-domain-snapshot.c \
$( top_srcdir) /src/libvirt-domain.c \
$( top_srcdir) /src/libvirt-host.c \
$( top_srcdir) /src/libvirt-interface.c \
$( top_srcdir) /src/libvirt-network.c \
$( top_srcdir) /src/libvirt-nodedev.c \
$( top_srcdir) /src/libvirt-nwfilter.c \
$( top_srcdir) /src/libvirt-secret.c \
$( top_srcdir) /src/libvirt-storage.c \
$( top_srcdir) /src/libvirt-stream.c \
2015-04-27 12:08:59 +03:00
$( top_srcdir) /src/libvirt-lxc.c \
$( top_srcdir) /src/libvirt-qemu.c \
2019-10-15 13:41:29 +03:00
$( top_srcdir) /src/admin/libvirt-admin.c \
2015-04-27 12:08:59 +03:00
$( top_srcdir) /src/util/virerror.c \
$( top_srcdir) /src/util/virevent.c \
2019-09-17 20:21:14 +03:00
$( top_srcdir) /src/util/virtypedparam-public.c
2019-09-05 18:45:27 +03:00
$( AM_V_GEN) srcdir = $( srcdir) builddir = $( builddir) \
$( RUNUTF8) $( PYTHON) $( APIBUILD)
2012-04-27 20:05:12 +04:00
touch $@