api: disallow virConnect*HypervisorCPU on read-only connections

These APIs can be used to execute arbitrary emulators.
Forbid them on read-only connections.

Fixes: CVE-2019-10168
Signed-off-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
(cherry picked from commit bf6c2830b6)
Signed-off-by: Ján Tomko <jtomko@redhat.com>

.ctags.d/libvirt.ctags

@@ -1 +0,0 @@
-../.ctags

.editorconfig

@@ -1,21 +0,0 @@
-# EditorConfig is a file format and collection of text editor plugins
-# for maintaining consistent coding styles between different editors
-# and IDEs. Most popular editors support this either natively or via
-# plugin.
-#
-# Check https://editorconfig.org for details.
-
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-charset = utf-8
-
-[*.c]
-indent_style = space
-indent_size = 4
-
-[*.{rng,xml}]
-indent_style = space
-indent_size = 2

.gitignore

@@ -1,44 +1,215 @@
-# vim related ignores
-*.swp
-.lvimrc
-
-# emacs related ignores
 *#*#
 *.#*#
-.#*
-
-# autotools related ignores
-!/m4/virt-*.m4
+*.[187]
+*.[187].in
+*.a
 *.cov
+*.exe
+*.exe.manifest
+*.gcda
+*.gcno
+*.gcov
+*.html
+*.i
+*.init
+*.la
+*.lo
+*.loT
+*.o
+*.orig
+*.pem
+*.pyc
+*.rej
+*.s
+*.service
+*.socket
+*.swp
+*~
+.#*
+.color_coded
+.deps
+.dirstamp
+.gdb_history
+.git
+.git-module-status
+.libs
+.lvimrc
+.memdump
+.sc-start-sc_*
+.ycm_extra_conf.py
 /AUTHORS
+/ChangeLog
+/GNUmakefile
 /INSTALL
+/NEWS
 /aclocal.m4
 /autom4te.cache
-/build-aux/.gitignore
-/build-aux/compile
-/build-aux/depcomp
-/build-aux/missing
-/build-aux/test-driver
+/build-aux/*
+/build/
+/confdefs.h
+/config.cache
+/config.guess
+/config.h
 /config.h.in
 /config.log
+/config.rpath
+/config.status
+/config.sub
 /configure
-/m4/*
-Makefile.in
-
-# gnulib related ignores
-!/gnulib/lib/Makefile.am
-!/gnulib/tests/Makefile.am
-*.rej
-*~
+/configure.lineno
+/conftest.*
+/docs/aclperms.htmlinc
+/docs/apibuild.py.stamp
+/docs/devhelp/libvirt.devhelp
+/docs/hvsupport.html.in
+/docs/libvirt-admin-*.xml
+/docs/libvirt-api.xml
+/docs/libvirt-lxc-*.xml
+/docs/libvirt-qemu-*.xml
+/docs/libvirt-refs.xml
+/docs/news.html.in
+/docs/search.php
+/docs/todo.html.in
+/examples/admin/client_close
+/examples/admin/client_info
+/examples/admin/client_limits
+/examples/admin/list_clients
+/examples/admin/list_servers
+/examples/admin/logging
+/examples/admin/threadpool_params
+/examples/object-events/event-test
+/examples/dominfo/info1
+/examples/domsuspend/suspend
+/examples/dommigrate/dommigrate
+/examples/domtop/domtop
+/examples/hellolibvirt/hellolibvirt
+/examples/openauth/openauth
+/examples/rename/rename
 /gnulib/lib/*
 /gnulib/m4/*
 /gnulib/tests/*
-
-# git related ignores
-*.orig
-.git-module-status
-
-# libvirt related ignores
-/build/
-/ci/scratch/
+/include/libvirt/libvirt-common.h
+/libtool
+/libvirt-*.tar.xz
+/libvirt-[0-9]*
+/libvirt*.pc
+/libvirt.spec
+/ltconfig
+/ltmain.sh
+/m4/*
+/maint.mk
+/mingw-libvirt.spec
+/mkinstalldirs
+/po/*gmo
+/po/*po
+!/po/*.mini.po
+/po/*pot
+/proxy/
+/python/
+/run
+/sc_*
+/src/.*.stamp
+/src/*.pc
+/src/access/org.libvirt.api.policy
+/src/access/viraccessapicheck.c
+/src/access/viraccessapicheck.h
+/src/access/viraccessapichecklxc.c
+/src/access/viraccessapichecklxc.h
+/src/access/viraccessapicheckqemu.c
+/src/access/viraccessapicheckqemu.h
+/src/admin/admin_client.h
+/src/admin/admin_protocol.[ch]
+/src/admin/admin_server_dispatch_stubs.h
+/src/esx/*.generated.*
+/src/hyperv/*.generated.*
+/src/libvirt*.def
+/src/libvirt.syms
+/src/libvirt_access.syms
+/src/libvirt_access.xml
+/src/libvirt_access_lxc.syms
+/src/libvirt_access_lxc.xml
+/src/libvirt_access_qemu.syms
+/src/libvirt_access_qemu.xml
+/src/libvirt_admin.syms
+/src/libvirt_*.stp
+/src/libvirt_*helper
+/src/libvirt_*probes.h
+/src/libvirt_lxc
+/src/libvirtd
+/src/libvirtd*.logrotate
+/src/locking/libxl-lockd.conf
+/src/locking/libxl-sanlock.conf
+/src/locking/lock_daemon_dispatch_stubs.h
+/src/locking/lock_protocol.[ch]
+/src/locking/qemu-lockd.conf
+/src/locking/qemu-sanlock.conf
+/src/locking/test_libvirt_sanlock.aug
+/src/logging/log_daemon_dispatch_stubs.h
+/src/logging/log_protocol.[ch]
+/src/lxc/lxc_controller_dispatch.h
+/src/lxc/lxc_monitor_dispatch.h
+/src/lxc/lxc_monitor_protocol.c
+/src/lxc/lxc_monitor_protocol.h
+/src/lxc/lxc_protocol.[ch]
+/src/lxc/test_libvirtd_lxc.aug
+/src/qemu/test_libvirtd_qemu.aug
+/src/remote/*_client_bodies.h
+/src/remote/*_protocol.[ch]
+/src/remote/*_stubs.h
+/src/rpc/virkeepaliveprotocol.[ch]
+/src/rpc/virnetprotocol.[ch]
+/src/test_libvirt*.aug
+/src/test_virtlockd.aug
+/src/test_virtlogd.aug
+/src/util/virkeycodetable*.h
+/src/util/virkeynametable*.h
+/src/virt-aa-helper
+/src/virtlockd
+/src/virtlogd
+/src/virt-guest-shutdown.target
+/tests/*.log
+/tests/*.pid
+/tests/*.trs
+/tests/*test
+/tests/commandhelper
+/tests/qemucapsprobe
+!/tests/virsh-self-test
+!/tests/virt-aa-helper-test
+!/tests/virt-admin-self-test
+/tests/objectlocking
+/tests/objectlocking-files.txt
+/tests/objectlocking.cm[ix]
+/tests/reconnect
+/tests/ssh
+/tests/test_file_access.txt
+/tests/test_conf
+/tools/libvirt-guests.sh
+/tools/virt-login-shell
+/tools/virsh
+/tools/virsh-*-edit.c
+/tools/virt-admin
+/tools/virt-*-validate
+/tools/virt-sanlock-cleanup
+/tools/wireshark/src/plugin.c
+/tools/wireshark/src/libvirt
+/update.log
+GPATH
+GRTAGS
+GTAGS
+Makefile
+Makefile.in
+TAGS
+coverage
+cscope.files
+cscope.in.out
+cscope.out
+cscope.po.out
+results.log
+stamp-h
+stamp-h.in
+stamp-h1
 tags
+!/build-aux/*.pl
+!/gnulib/lib/Makefile.am
+!/gnulib/tests/Makefile.am
+!/m4/virt-*.m4

.gitlab-ci.yml

@@ -1,46 +0,0 @@
-.job_template: &job_definition
-  script:
-    - mkdir build
-    - cd build
-    - ../autogen.sh $CONFIGURE_OPTS || (cat config.log && exit 1)
-    - make -j $(getconf _NPROCESSORS_ONLN)
-
-# We could run every arch on every versions, but it is a little
-# overkill. Instead we split jobs evenly across 9, 10 and sid
-# to achieve reasonable cross-coverage.
-
-debian-9-cross-armv6l:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-9-cross-armv6l:latest
-
-debian-9-cross-mips64el:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-9-cross-mips64el:latest
-
-debian-9-cross-mips:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-9-cross-mips:latest
-
-debian-10-cross-aarch64:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-10-cross-aarch64:latest
-
-debian-10-cross-ppc64le:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-10-cross-ppc64le:latest
-
-debian-10-cross-s390x:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-10-cross-s390x:latest
-
-debian-sid-cross-armv7l:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-sid-cross-armv7l:latest
-
-debian-sid-cross-i686:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-sid-cross-i686:latest
-
-debian-sid-cross-mipsel:
-  <<: *job_definition
-  image: quay.io/libvirt/buildenv-libvirt-debian-sid-cross-mipsel:latest

.mailmap

@@ -43,10 +43,6 @@
 <nshirokovskiy@virtuozzo.com> <nshirokovskiy@parallels.com>
 <jyang@redhat.com> <osier@yunify.com>
 <kkoukiou@redhat.com> <k.koukiou@googlemail.com>
-<intrigeri@boum.org> <intrigeri+libvirt@boum.org>
-<fidencio@redhat.com> <fabiano@fidencio.org>
-<shi_lei@massclouds.com> <shilei.massclouds@gmx.com>
-<adrian.brzezinski@eo.pl> <redhat@adrb.pl>
 
 # Name consolidation:
 # Preferred author spelling <preferred email>

.travis.yml

@@ -5,102 +5,95 @@ branches:
   except:
     - /^.*-maint$/
 
-addons:
-  homebrew:
-    update: true
-    packages:
-      - ccache
-      - rpcgen
-      - xz
-      - yajl
-      - glib
-      - docutils
-
 matrix:
   include:
     - services:
         - docker
       env:
-        - IMAGE="ubuntu-1804"
-        - MAKE_ARGS="syntax-check distcheck"
-      script:
-        - make -C ci/ ci-build@$IMAGE CI_MAKE_ARGS="$MAKE_ARGS"
+        - IMAGE="ubuntu-18"
+        - DISTCHECK_CONFIGURE_FLAGS="--with-init-script=systemd"
+        - DOCKER_CMD="$LINUX_CMD"
     - services:
         - docker
       env:
         - IMAGE="centos-7"
-        - MAKE_ARGS="syntax-check distcheck"
-      script:
-        - make -C ci/ ci-build@$IMAGE CI_MAKE_ARGS="$MAKE_ARGS"
-    - services:
-        - docker
-      env:
-        - IMAGE="debian-9"
-        - MAKE_ARGS="syntax-check distcheck"
-      script:
-        - make -C ci/ ci-build@$IMAGE CI_MAKE_ARGS="$MAKE_ARGS"
-    - services:
-        - docker
-      env:
-        - IMAGE="fedora-31"
-        - MAKE_ARGS="syntax-check distcheck"
-      script:
-        - make -C ci/ ci-build@$IMAGE CI_MAKE_ARGS="$MAKE_ARGS"
+        - DISTCHECK_CONFIGURE_FLAGS="--with-init-script=upstart"
+        - DOCKER_CMD="$LINUX_CMD"
     - services:
         - docker
       env:
         - IMAGE="fedora-rawhide"
-        - MAKE_ARGS="syntax-check distcheck"
-      script:
-        - make -C ci/ ci-build@$IMAGE CI_MAKE_ARGS="$MAKE_ARGS"
-    - services:
-        - docker
-      env:
-        - IMAGE="fedora-30"
         - MINGW="mingw32"
-      script:
-        - make -C ci/ ci-build@$IMAGE CI_CONFIGURE="$MINGW-configure"
+        - DOCKER_CMD="$MINGW_CMD"
     - services:
         - docker
       env:
-        - IMAGE="fedora-30"
+        - IMAGE="fedora-rawhide"
         - MINGW="mingw64"
-      script:
-        - make -C ci/ ci-build@$IMAGE CI_CONFIGURE="$MINGW-configure"
+        - DOCKER_CMD="$MINGW_CMD"
     - compiler: clang
       language: c
       os: osx
-      osx_image: xcode10.3
       env:
         - PATH="/usr/local/opt/gettext/bin:/usr/local/opt/ccache/libexec:/usr/local/opt/rpcgen/bin:$PATH"
-        - PKG_CONFIG_PATH="/usr/local/opt/libxml2/lib/pkgconfig"
-      before_script:
-        # Hack to blow away py2
-        - brew link --overwrite python
       script:
-        # We can't run 'distcheck' or 'syntax-check' because they fail on
-        # macOS, but doing 'install' and 'dist' gives us some useful coverage
-        - mkdir build && cd build
-        - ../autogen.sh --prefix=$(pwd)/install-root && make -j3 && make -j3 install && make -j3 dist
-    - compiler: clang
-      language: c
-      os: osx
-      osx_image: xcode11.3
-      env:
-        - PATH="/usr/local/opt/gettext/bin:/usr/local/opt/ccache/libexec:/usr/local/opt/rpcgen/bin:$PATH"
-        - PKG_CONFIG_PATH="/usr/local/opt/libxml2/lib/pkgconfig"
-      before_script:
-        # Hack to blow away py2
-        - brew link --overwrite python
-      script:
-        # We can't run 'distcheck' or 'syntax-check' because they fail on
-        # macOS, but doing 'install' and 'dist' gives us some useful coverage
-        - mkdir build && cd build
-        - ../autogen.sh --prefix=$(pwd)/install-root && make -j3 && make -j3 install && make -j3 dist
+        /bin/sh -xc "$MACOS_CMD"
+
+script:
+  - docker run
+      -v $(pwd):/build
+      -w /build
+      -e VIR_TEST_DEBUG="$VIR_TEST_DEBUG"
+      -e MINGW="$MINGW"
+      -e DISTCHECK_CONFIGURE_FLAGS="$DISTCHECK_CONFIGURE_FLAGS"
+      "quay.io/libvirt/buildenv-$IMAGE:master"
+      /bin/sh -xc "$DOCKER_CMD"
 
 git:
   submodules: true
 
+env:
+  global:
+    - VIR_TEST_DEBUG=1
+    - LINUX_CMD="
+        ./autogen.sh &&
+        make -j3 syntax-check &&
+        make -j3 distcheck DISTCHECK_CONFIGURE_FLAGS=\"\$DISTCHECK_CONFIGURE_FLAGS\" ||
+        (
+          echo '=== LOG FILE(S) START ===';
+          find -name test-suite.log | xargs cat;
+          echo '=== LOG FILE(S) END ===';
+          exit 1
+        )
+      "
+    - MINGW_CMD="
+        NOCONFIGURE=1 ./autogen.sh &&
+        \$MINGW-configure &&
+        make -j3 ||
+        (
+          echo '=== LOG FILE(S) START ===';
+          find -name test-suite.log | xargs cat;
+          echo '=== LOG FILE(S) END ===';
+          exit 1
+        )
+      "
+    # We can't run 'distcheck' or 'syntax-check' because they fail on
+    # macOS, but doing 'install' and 'dist' gives us some useful coverage
+    - MACOS_CMD="
+        brew update &&
+        brew install ccache rpcgen xz yajl &&
+        ./autogen.sh --prefix=\$(pwd)/install-root &&
+        make -j3 &&
+        make -j3 install &&
+        make -j3 dist ||
+        (
+          echo '=== LOG FILE(S) START ===';
+          find -name test-suite.log | xargs cat;
+          echo '=== LOG FILE(S) END ===';
+          exit 1
+        )
+      "
+
 notifications:
   irc:
     # The channel name "irc.oftc.net#virt" is encrypted against libvirt/libvirt

AUTHORS.in

@@ -19,7 +19,6 @@ Daniel Veillard <veillard@redhat.com>
 Doug Goldstein <cardoe@gentoo.org>
 Eric Blake <eblake@redhat.com>
 Erik Skultety <eskultet@redhat.com>
-Fabiano Fidêncio <fidencio@redhat.com>
 Gao Feng <gaofeng@cn.fujitsu.com>
 Guido Günther <agx@sigxcpu.org>
 Ján Tomko <jtomko@redhat.com>

ChangeLog

@@ -1,15 +0,0 @@
-libvirt ChangeLog
-=================
-
-The libvirt project doesn't include a detailed ChangeLog in its release
-archives.
-
-If you're interested in the full list of changes made to libvirt since
-the project was started, you can clone the git repository from
-
-  https://libvirt.org/git/libvirt.git
-
-and browse them locally using your favorite git history viewer or,
-alternatively, browse them online at
-
-  https://libvirt.org/git/?p=libvirt.git;a=log

GNUmakefile

@@ -1,74 +0,0 @@
-# Having a separate GNUmakefile lets me 'include' the dynamically
-# generated rules created via cfg.mk (package-local configuration)
-# as well as maint.mk (generic maintainer rules).
-# This makefile is used only if you run GNU Make.
-# It is necessary if you want to build targets usually of interest
-# only to the maintainer.
-
-# Copyright (C) 2001, 2003, 2006-2019 Free Software Foundation, Inc.
-
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-
-# This program 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 General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-_build-aux ?= build-aux
-_autoreconf ?= autoreconf -v
-
-# If the user runs GNU make but has not yet run ./configure,
-# give them a diagnostic.
-_gl-Makefile := $(wildcard [M]akefile)
-ifneq ($(_gl-Makefile),)
-
-# Make tar archive easier to reproduce.
-export TAR_OPTIONS = --owner=0 --group=0 --numeric-owner
-
-# Allow the user to add to this in the Makefile.
-ALL_RECURSIVE_TARGETS =
-
-include Makefile
-include $(srcdir)/$(_build-aux)/syntax-check.mk
-
-else
-
-.DEFAULT_GOAL := abort-due-to-no-makefile
-srcdir = .
-
-# The package can override .DEFAULT_GOAL to run actions like autoreconf.
-include $(srcdir)/$(_build-aux)/syntax-check.mk
-
-ifeq ($(.DEFAULT_GOAL),abort-due-to-no-makefile)
-$(MAKECMDGOALS): abort-due-to-no-makefile
-endif
-
-abort-due-to-no-makefile:
-	@echo There seems to be no Makefile in this directory.   1>&2
-	@echo "You must run ./configure before running 'make'." 1>&2
-	@exit 1
-
-endif
-
-# Tell version 3.79 and up of GNU make to not build goals in this
-# directory in parallel, in case someone tries to build multiple
-# targets, and one of them can cause a recursive target to be invoked.
-
-# Only set this if Automake doesn't provide it.
-AM_RECURSIVE_TARGETS ?= $(RECURSIVE_TARGETS:-recursive=) \
-  $(RECURSIVE_CLEAN_TARGETS:-recursive=) \
-  dist distcheck tags ctags
-
-ALL_RECURSIVE_TARGETS += $(AM_RECURSIVE_TARGETS)
-
-ifneq ($(word 2, $(MAKECMDGOALS)), )
-ifneq ($(filter $(ALL_RECURSIVE_TARGETS), $(MAKECMDGOALS)), )
-.NOTPARALLEL:
-endif
-endif

Makefile.am

@@ -19,10 +19,6 @@
 LCOV = lcov
 GENHTML = genhtml
 
-# when building from tarball -Werror isn't auto enabled
-# so force it explicitly
-DISTCHECK_CONFIGURE_FLAGS = --enable-werror
-
 SUBDIRS = . gnulib/lib include/libvirt src tools docs gnulib/tests \
   tests po examples
 
@@ -33,6 +29,7 @@ ACLOCAL_AMFLAGS = -I m4
 
 EXTRA_DIST = \
   config-post.h \
+  ChangeLog-old \
   libvirt.spec libvirt.spec.in \
   mingw-libvirt.spec.in \
   libvirt.pc.in \
@@ -41,43 +38,10 @@ EXTRA_DIST = \
   libvirt-admin.pc.in \
   Makefile.nonreentrant \
   autogen.sh \
-  GNUmakefile \
+  cfg.mk \
   run.in \
   README.md \
-  AUTHORS.in \
-  scripts/apibuild.py \
-  scripts/augeas-gentest.py \
-  build-aux/check-spacing.pl \
-  scripts/check-aclperms.py \
-  scripts/check-aclrules.py \
-  scripts/check-drivername.py \
-  scripts/check-driverimpls.py \
-  scripts/check-file-access.py \
-  scripts/check-remote-protocol.py \
-  scripts/check-symfile.py \
-  scripts/check-symsorting.py \
-  scripts/dtrace2systemtap.py \
-  scripts/esx_vi_generator.py \
-  scripts/genaclperms.py \
-  scripts/genpolkit.py \
-  scripts/gensystemtap.py \
-  scripts/group-qemu-caps.py \
-  scripts/header-ifdef.py \
-  scripts/hvsupport.py \
-  scripts/hyperv_wmi_generator.py \
-  scripts/minimize-po.py \
-  scripts/mock-noinline.py \
-  scripts/prohibit-duplicate-header.py \
-  scripts/reformat-news.py \
-  scripts/test-wrap-argv.py \
-  build-aux/syntax-check.mk \
-  build-aux/useless-if-before-free \
-  build-aux/vc-list-files \
-  ci/Makefile \
-  ci/build.sh \
-  ci/list-images.sh \
-  ci/prepare.sh \
-  $(NULL)
+  AUTHORS.in
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libvirt.pc libvirt-qemu.pc libvirt-lxc.pc libvirt-admin.pc
@@ -85,7 +49,7 @@ pkgconfig_DATA = libvirt.pc libvirt-qemu.pc libvirt-lxc.pc libvirt-admin.pc
 NEWS: \
 	  $(srcdir)/docs/news.xml \
 	  $(srcdir)/docs/news-ascii.xsl \
-	  $(top_srcdir)/scripts/reformat-news.py
+	  $(srcdir)/docs/reformat-news.py
 	$(AM_V_GEN) \
 	if [ -x $(XSLTPROC) ]; then \
 	  $(XSLTPROC) --nonet \
@@ -93,14 +57,14 @@ NEWS: \
 	    $(srcdir)/docs/news.xml \
 	  >$@-tmp \
 	    || { rm -f $@-tmp; exit 1; }; \
-	  $(RUNUTF8) $(PYTHON) $(top_srcdir)/scripts/reformat-news.py $@-tmp >$@ \
+	  $(PYTHON) $(srcdir)/docs/reformat-news.py $@-tmp >$@ \
 	    || { rm -f $@-tmp; exit 1; }; \
 	  rm -f $@-tmp; \
 	fi
 EXTRA_DIST += \
 	$(srcdir)/docs/news.xml \
 	$(srcdir)/docs/news-ascii.xsl \
-	$(NULL)
+	$(srcdir)/docs/reformat-news.py
 
 rpm: clean
 	@(unset CDPATH ; $(MAKE) dist && rpmbuild -ta $(distdir).tar.xz)
@@ -110,7 +74,7 @@ srpm: clean
 
 check-local: all tests
 
-check-access: all
+check-access:
 	@($(MAKE) $(AM_MAKEFLAGS) -C tests check-access)
 
 cov: clean-cov
@@ -129,11 +93,19 @@ clean-cov:
 
 MAINTAINERCLEANFILES = .git-module-status
 
-distclean-local: clean-GNUmakefile
-clean-GNUmakefile:
-	test '$(srcdir)' = . || rm -f $(top_builddir)/GNUmakefile
+dist-hook: gen-ChangeLog gen-AUTHORS
 
-dist-hook: gen-AUTHORS
+# Generate the ChangeLog file (with all entries since the switch to git)
+# and insert it into the directory we're about to use to create a tarball.
+gen_start_date = 2009-07-04
+.PHONY: gen-ChangeLog
+gen-ChangeLog:
+	$(AM_V_GEN)if test -d .git; then \
+	  $(top_srcdir)/build-aux/gitlog-to-changelog \
+	    --since=$(gen_start_date) > $(distdir)/cl-t; \
+	  rm -f $(distdir)/ChangeLog; \
+	  mv $(distdir)/cl-t $(distdir)/ChangeLog; \
+	fi
 
 .PHONY: gen-AUTHORS
 gen-AUTHORS:
@@ -151,6 +123,3 @@ gen-AUTHORS:
 	  mv -f $(distdir)/AUTHORS-tmp $(distdir)/AUTHORS && \
 	  rm -f all.list maint.list contrib.list; \
 	fi
-
-ci-%:
-	$(MAKE) -C $(srcdir)/ci/ $@

README-hacking

@@ -11,7 +11,7 @@ We've opted to keep only the highest-level sources in the GIT repository.
 This eases our maintenance burden, (fewer merges etc.), but imposes more
 requirements on anyone wishing to build from the just-checked-out sources.
 Note the requirements to build the released archive are much less and
-are just the requirements of the standard configure && make procedure.
+are just the requirements of the standard ./configure && make procedure.
 Specific development tools and versions will be checked for and listed by
 the bootstrap script.
 
@@ -34,14 +34,10 @@ reduce download time and disk space requirements:
 
         $ export GNULIB_SRCDIR=/path/to/gnulib
 
-We require to have the build directory different than the source directory:
-
-        $ mkdir build && cd build
-
 The next step is to get all required pieces from gnulib,
-to run autoreconf, and to invoke ../autogen.sh:
+to run autoreconf, and to invoke ./configure:
 
-        $ ../autogen.sh
+        $ ./autogen.sh
 
 And there you are!  Just
 
@@ -51,7 +47,6 @@ And there you are!  Just
 At this point, there should be no difference between your local copy,
 and the GIT master copy:
 
-        $ cd ..
         $ git diff
 
 should output no difference.

README.md

@@ -30,7 +30,7 @@ License
 The libvirt C API is distributed under the terms of GNU Lesser General
 Public License, version 2.1 (or later). Some parts of the code that are
 not part of the C library may have the more restrictive GNU General
-Public License, version 2.0 (or later). See the files `COPYING.LESSER`
+Public License, version 2.1 (or later). See the files `COPYING.LESSER`
 and `COPYING` for full license terms & conditions.
 
 
@@ -38,13 +38,11 @@ Installation
 ------------
 
 Libvirt uses the GNU Autotools build system, so in general can be built
-and installed with the usual commands, however, we mandate to have the
-build directory different than the source directory. For example, to build
-in a manner that is suitable for installing as root, use:
+and installed with the usual commands. For example, to build in a manner
+that is suitable for installing as root, use:
 
 ```
-$ mkdir build && cd build
-$ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
+$ ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
 $ make
 $ sudo make install
 ```
@@ -52,8 +50,7 @@ $ sudo make install
 While to build & install as an unprivileged user
 
 ```
-$ mkdir build && cd build
-$ ../configure --prefix=$HOME/usr
+$ ./configure --prefix=$HOME/usr
 $ make
 $ make install
 ```

bootstrap

@@ -4,7 +4,7 @@ scriptversion=2019-01-04.17; # UTC
 
 # Bootstrap this package from checked-out sources.
 
-# Copyright (C) 2003-2020 Free Software Foundation, Inc.
+# Copyright (C) 2003-2019 Free Software Foundation, Inc.
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -166,7 +166,7 @@ bootstrap_epilogue() { :; }
 # specified directory.  Fill in the first %s with the destination
 # directory and the second with the domain name.
 po_download_command_format=\
-"wget --mirror --level=1 -nd -nv -A.po -P '%s' \
+"wget --mirror --level=1 -nd -q -A.po -P '%s' \
  https://translationproject.org/latest/%s/"
 
 # Prefer a non-empty tarname (4th argument of AC_INIT if given), else

bootstrap.conf

@@ -10,120 +10,124 @@
 # This program 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.
+# GNU 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/>.
 
 # gnulib modules used by this package.
-
-# NB the GSocket conversion is non-trivial due to the
-# different FD vs HANDLE usage in gnulib vs glib. Need
-# to find a way to duplicate a socket HANDLE before
-# turning it into a FD, since closing an FD also closes
-# the original HANDLE.
-
-# -> GSocket
-gnulib_modules="$gnulib_modules accept"
-# -> GSocket
-gnulib_modules="$gnulib_modules bind"
-# -> conditional build to avoid Win32
-gnulib_modules="$gnulib_modules chown"
-# -> GSocket
-gnulib_modules="$gnulib_modules close"
-# -> GSocket
-gnulib_modules="$gnulib_modules connect"
-# -> Meson
-gnulib_modules="$gnulib_modules configmake"
-# -> eliminate usage in some manner
-gnulib_modules="$gnulib_modules environ"
-# -> GSocket
-gnulib_modules="$gnulib_modules fcntl"
-# -> conditional build avoid win32
-gnulib_modules="$gnulib_modules fcntl-h"
-# -> GSocket
-gnulib_modules="$gnulib_modules getaddrinfo"
-# -> copy gnuliub win32 impl
-gnulib_modules="$gnulib_modules getpass"
-# -> GSocket
-gnulib_modules="$gnulib_modules getpeername"
-# -> GSocket
-gnulib_modules="$gnulib_modules getsockname"
-# -> copy gnulib STRBUFLEN macro
-gnulib_modules="$gnulib_modules intprops"
-# -> GSocket
-gnulib_modules="$gnulib_modules ioctl"
-# -> Meson
-gnulib_modules="$gnulib_modules largefile"
-# -> GSocket
-gnulib_modules="$gnulib_modules listen"
-# -> custom configure check
-gnulib_modules="$gnulib_modules localeconv"
-# -> Meson
-gnulib_modules="$gnulib_modules manywarnings"
-# -> painful copy gnulib
-gnulib_modules="$gnulib_modules mgetgroups"
-# -> GSocket
-gnulib_modules="$gnulib_modules net_if"
-# -> GSocket
-gnulib_modules="$gnulib_modules netdb"
-# -> GSocket
-gnulib_modules="$gnulib_modules nonblocking"
-# -> Just add -lutil to cli
-gnulib_modules="$gnulib_modules openpty"
-# -> GSocket
-gnulib_modules="$gnulib_modules passfd"
-# -> open code / copy gnulib code
-gnulib_modules="$gnulib_modules physmem"
-# -> open code / conditional comp
-gnulib_modules="$gnulib_modules pipe-posix"
-# -> open code / conditional comp
-gnulib_modules="$gnulib_modules pipe2"
-# -> GMainLoop
-gnulib_modules="$gnulib_modules poll"
-# -> Meson
-gnulib_modules="$gnulib_modules posix-shell"
-# -> open code conditional logic
-gnulib_modules="$gnulib_modules pthread_sigmask"
-# -> GSocket
-gnulib_modules="$gnulib_modules recv"
-# -> GSocket
-gnulib_modules="$gnulib_modules send"
-# -> GSocket
-gnulib_modules="$gnulib_modules setsockopt"
-# -> open code conditional logic
-gnulib_modules="$gnulib_modules sigaction"
-# -> open code conditional logic
-gnulib_modules="$gnulib_modules sigpipe"
-# -> GSocket
-gnulib_modules="$gnulib_modules socket"
-# -> open code conditional or use GIO GFileInfo
-gnulib_modules="$gnulib_modules stat-time"
-# -> remove use or open-code it. possibly add to glib
-gnulib_modules="$gnulib_modules strchrnul"
-# -> g_strsplit
-gnulib_modules="$gnulib_modules strtok_r"
-# -> remove sys/stat.h include from any win32 code paths
-gnulib_modules="$gnulib_modules sys_stat"
-# -> remove sys/wait.h include from any win32 code paths
-gnulib_modules="$gnulib_modules sys_wait"
-# -> remove from any win32 code paths
-gnulib_modules="$gnulib_modules termios"
-# -> GDateTime ?
-gnulib_modules="$gnulib_modules time_r"
-# -> obsolete - exists on Linux, MacOS >= ?? & FreeBSD >= 6
-gnulib_modules="$gnulib_modules ttyname_r"
-# -> g_get_os_info in GLib 2.64 but can't use that yet
-gnulib_modules="$gnulib_modules uname"
-# -> G_STATIC_ASSERT
-gnulib_modules="$gnulib_modules verify"
-# -> remove from Win32 code paths
-gnulib_modules="$gnulib_modules waitpid"
-# -> Meson
-gnulib_modules="$gnulib_modules warnings"
-# -> open code impl
-gnulib_modules="$gnulib_modules wcwidth"
+gnulib_modules='
+accept
+areadlink
+autobuild
+base64
+bind
+bitrotate
+byteswap
+c-ctype
+c-strcase
+c-strcasestr
+calloc-posix
+canonicalize-lgpl
+chown
+clock-time
+close
+connect
+configmake
+count-leading-zeros
+count-one-bits
+dirname-lgpl
+environ
+execinfo
+fclose
+fcntl
+fcntl-h
+fdatasync
+ffs
+ffsl
+fnmatch
+fsync
+func
+getaddrinfo
+getcwd-lgpl
+gethostname
+getopt-posix
+getpass
+getpeername
+getsockname
+gettimeofday
+gitlog-to-changelog
+gnumakefile
+ignore-value
+inet_pton
+intprops
+ioctl
+isatty
+largefile
+ldexp
+listen
+localeconv
+maintainer-makefile
+manywarnings
+mgetgroups
+mkdtemp
+mkostemp
+mkostemps
+mktempd
+net_if
+netdb
+nonblocking
+openpty
+passfd
+perror
+physmem
+pipe-posix
+pipe2
+poll
+posix-shell
+pthread
+pthread_sigmask
+recv
+regex
+sched
+secure_getenv
+send
+setenv
+setsockopt
+sigaction
+sigpipe
+snprintf
+socket
+stat-time
+stdarg
+stpcpy
+strchrnul
+strdup-posix
+strndup
+strerror
+strerror_r-posix
+strptime
+strsep
+strtok_r
+sys_stat
+sys_wait
+termios
+time_r
+timegm
+ttyname_r
+uname
+unsetenv
+useless-if-before-free
+usleep
+vasprintf
+verify
+vc-list-files
+vsnprintf
+waitpid
+warnings
+wcwidth
+'
 
 SKIP_PO=true
 
@@ -172,8 +176,8 @@ xmllint	   -
 xsltproc   -
 "
 
-# Automake requires that AUTHORS exist.
-touch AUTHORS || exit 1
+# Automake requires that ChangeLog and AUTHORS exist.
+touch AUTHORS ChangeLog || exit 1
 
 # Override bootstrap's list - we don't use mdate-sh or texinfo.tex.
 gnulib_extra_files="
@@ -193,9 +197,3 @@ bootstrap_post_import_hook()
   sed 's,\.\./\.\./\.\.,../..,g; s/^TESTS /GNULIB_TESTS /' $m > $m-t
   mv -f $m-t $m
 }
-
-bootstrap_epilogue()
-{
-    echo "$0: done.  Now you can run 'mkdir build && cd build && ../configure'."
-    exit 0
-}

build-aux/augeas-gentest.pl

@@ -0,0 +1,68 @@
+#!/usr/bin/env perl
+#
+# augeas-gentest.pl: Generate an augeas test file, from an
+#                    example config file + test file template
+#
+# 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/>.
+
+use strict;
+use warnings;
+
+die "syntax: $0 CONFIG TEMPLATE AUGTEST\n" unless @ARGV == 3;
+
+my $config = shift @ARGV;
+my $template = shift @ARGV;
+my $augtest = shift @ARGV;
+
+open AUGTEST, ">", $augtest or die "cannot create $augtest: $!";
+
+$SIG{__DIE__} = sub {
+    unlink $augtest;
+};
+
+open CONFIG, "<", $config or die "cannot read $config: $!";
+open TEMPLATE, "<", $template or die "cannot read $template: $!";
+
+my $group = 0;
+while (<TEMPLATE>) {
+    if (/::CONFIG::/) {
+        my $group = 0;
+        print AUGTEST "  let conf = \"";
+        while (<CONFIG>) {
+            if (/^#\w/) {
+                s/^#//;
+                s/\"/\\\"/g;
+                print AUGTEST $_;
+                $group = /\[\s$/;
+            } elsif ($group) {
+                s/\"/\\\"/g;
+                if (/#\s*\]/) {
+                    $group = 0;
+                }
+                if (/^#/) {
+                    s/^#//;
+                    print AUGTEST $_;
+                }
+            }
+        }
+        print AUGTEST "\"\n";
+    } else {
+        print AUGTEST $_;
+    }
+}
+
+close TEMPLATE;
+close CONFIG;
+close AUGTEST or die "cannot save $augtest: $!";

build-aux/header-ifdef.pl

@@ -0,0 +1,156 @@
+#!/usr/bin/perl
+#
+# Validate that header files follow a standard layout:
+#
+# /*
+#  ...copyright header...
+#  */
+# <one blank line>
+# #ifndef SYMBOL
+# # define SYMBOL
+# ....content....
+# #endif /* SYMBOL */
+#
+# For any file ending priv.h, before the #ifndef
+# We will have a further section
+#
+# #ifndef SYMBOL_ALLOW
+# # error ....
+# #endif /* SYMBOL_ALLOW */
+# <one blank line>
+
+use strict;
+use warnings;
+
+my $STATE_COPYRIGHT_COMMENT = 0;
+my $STATE_COPYRIGHT_BLANK = 1;
+my $STATE_PRIV_START = 2;
+my $STATE_PRIV_ERROR = 3;
+my $STATE_PRIV_END = 4;
+my $STATE_PRIV_BLANK = 5;
+my $STATE_GUARD_START = 6;
+my $STATE_GUARD_DEFINE = 7;
+my $STATE_GUARD_END = 8;
+my $STATE_EOF = 9;
+
+my $file = " ";
+my $ret = 0;
+my $ifdef = "";
+my $ifdefpriv = "";
+
+my $state = $STATE_EOF;
+my $mistake = 0;
+
+sub mistake {
+    my $msg = shift;
+    warn $msg;
+    $mistake = 1;
+    $ret = 1;
+}
+
+while (<>) {
+    if (not $file eq $ARGV) {
+        if ($state == $STATE_COPYRIGHT_COMMENT) {
+            &mistake("$file: missing copyright comment");
+        } elsif ($state == $STATE_COPYRIGHT_BLANK) {
+            &mistake("$file: missing blank line after copyright header");
+        } elsif ($state == $STATE_PRIV_START) {
+            &mistake("$file: missing '#ifndef $ifdefpriv'");
+        } elsif ($state == $STATE_PRIV_ERROR) {
+            &mistake("$file: missing '# error ...priv allow...'");
+        } elsif ($state == $STATE_PRIV_END) {
+            &mistake("$file: missing '#endif /* $ifdefpriv */'");
+        } elsif ($state == $STATE_PRIV_BLANK) {
+            &mistake("$file: missing blank line after priv header check");
+        } elsif ($state == $STATE_GUARD_START) {
+            &mistake("$file: missing '#ifndef $ifdef'");
+        } elsif ($state == $STATE_GUARD_DEFINE) {
+            &mistake("$file: missing '# define $ifdef'");
+        } elsif ($state == $STATE_GUARD_END) {
+            &mistake("$file: missing '#endif /* $ifdef */'");
+        }
+
+        $ifdef = uc $ARGV;
+        $ifdef =~ s,.*/,,;
+        $ifdef =~ s,[^A-Z0-9],_,g;
+        $ifdef =~ s,__+,_,g;
+        unless ($ifdef =~ /^LIBVIRT_/ && $ARGV !~ /libvirt_internal.h/) {
+            $ifdef = "LIBVIRT_" . $ifdef;
+        }
+        $ifdefpriv = $ifdef . "_ALLOW";
+
+        $file = $ARGV;
+        $state = $STATE_COPYRIGHT_COMMENT;
+        $mistake = 0;
+    }
+
+    if ($mistake ||
+        $ARGV =~ /config-post\.h$/ ||
+        $ARGV =~ /vbox_(CAPI|XPCOM)/) {
+        $state = $STATE_EOF;
+        next;
+    }
+
+    if ($state == $STATE_COPYRIGHT_COMMENT) {
+        if (m,\*/,) {
+            $state = $STATE_COPYRIGHT_BLANK;
+        }
+    } elsif ($state == $STATE_COPYRIGHT_BLANK) {
+        if (! /^$/) {
+            &mistake("$file: missing blank line after copyright header");
+        }
+        if ($ARGV =~ /priv\.h$/) {
+            $state = $STATE_PRIV_START;
+        } else {
+            $state = $STATE_GUARD_START;
+        }
+    } elsif ($state == $STATE_PRIV_START) {
+        if (/^$/) {
+            &mistake("$file: too many blank lines after coyright header");
+        } elsif (/#ifndef $ifdefpriv$/) {
+            $state = $STATE_PRIV_ERROR;
+        } else {
+            &mistake("$file: missing '#ifndef $ifdefpriv'");
+        }
+    } elsif ($state == $STATE_PRIV_ERROR) {
+        if (/# error ".*"$/) {
+            $state = $STATE_PRIV_END;
+        } else {
+            &mistake("$file: missing '#error ...priv allow...'");
+        }
+    } elsif ($state == $STATE_PRIV_END) {
+        if (m,#endif /\* $ifdefpriv \*/,) {
+            $state = $STATE_PRIV_BLANK;
+        } else {
+            &mistake("$file: missing '#endif /* $ifdefpriv */'");
+        }
+    } elsif ($state == $STATE_PRIV_BLANK) {
+        if (! /^$/) {
+            &mistake("$file: missing blank line after priv guard");
+        }
+        $state = $STATE_GUARD_START;
+    } elsif ($state == $STATE_GUARD_START) {
+        if (/^$/) {
+            &mistake("$file: too many blank lines after coyright header");
+        } elsif (/#ifndef $ifdef$/) {
+            $state = $STATE_GUARD_DEFINE;
+        } else {
+            &mistake("$file: missing '#ifndef $ifdef'");
+        }
+    } elsif ($state == $STATE_GUARD_DEFINE) {
+        if (/# define $ifdef$/) {
+            $state = $STATE_GUARD_END;
+        } else {
+            &mistake("$file: missing '# define $ifdef'");
+        }
+    } elsif ($state == $STATE_GUARD_END) {
+        if (m,#endif /\* $ifdef \*/$,) {
+            $state = $STATE_EOF;
+        }
+    } elsif ($state == $STATE_EOF) {
+        die "$file: unexpected content after '#endif /* $ifdef */'";
+    } else {
+        die "$file: unexpected state $state";
+    }
+}
+exit $ret;

build-aux/minimize-po.pl

@@ -0,0 +1,37 @@
+#!/usr/bin/perl
+
+my @block;
+my $msgstr = 0;
+my $empty = 0;
+my $unused = 0;
+my $fuzzy = 0;
+while (<>) {
+    if (/^$/) {
+        if (!$empty && !$unused && !$fuzzy) {
+            print @block;
+        }
+        @block = ();
+        $msgstr = 0;
+        $fuzzy = 0;
+        push @block, $_;
+    } else {
+        if (/^msgstr/) {
+            $msgstr = 1;
+            $empty = 1;
+        }
+        if (/^#.*fuzzy/) {
+            $fuzzy = 1;
+        }
+        if (/^#~ msgstr/) {
+            $unused = 1;
+        }
+        if ($msgstr && /".+"/) {
+            $empty = 0;
+        }
+        push @block, $_;
+    }
+}
+
+if (@block && !$empty && !$unused) {
+    print @block;
+}

build-aux/mock-noinline.pl

@@ -0,0 +1,72 @@
+#!/usr/bin/env perl
+
+my %noninlined;
+my %mocked;
+
+# Functions in public header don't get the noinline annotation
+# so whitelist them here
+$noninlined{"virEventAddTimeout"} = 1;
+
+foreach my $arg (@ARGV) {
+    if ($arg =~ /\.h$/) {
+        #print "Scan header $arg\n";
+        &scan_annotations($arg);
+    } elsif ($arg =~ /mock\.c$/) {
+        #print "Scan mock $arg\n";
+        &scan_overrides($arg);
+    }
+}
+
+my $warned = 0;
+foreach my $func (keys %mocked) {
+    next if exists $noninlined{$func};
+
+    $warned++;
+    print STDERR "$func is mocked at $mocked{$func} but missing noinline annotation\n";
+}
+
+exit $warned ? 1 : 0;
+
+
+sub scan_annotations {
+    my $file = shift;
+
+    open FH, $file or die "cannot read $file: $!";
+
+    my $func;
+    while (<FH>) {
+        if (/^\s*(\w+)\(/ || /^(?:\w+\*?\s+)+(?:\*\s*)?(\w+)\(/) {
+            my $name = $1;
+            if ($name !~ /ATTRIBUTE/) {
+                $func = $name;
+            }
+        } elsif (/^\s*$/) {
+            $func = undef;
+        }
+        if (/ATTRIBUTE_NOINLINE/) {
+            if (defined $func) {
+                $noninlined{$func} = 1;
+            }
+        }
+    }
+
+    close FH
+}
+
+sub scan_overrides {
+    my $file = shift;
+
+    open FH, $file or die "cannot read $file: $!";
+
+    my $func;
+    while (<FH>) {
+        if (/^(\w+)\(/ || /^\w+\s*(?:\*\s*)?(\w+)\(/) {
+            my $name = $1;
+            if ($name =~ /^vir/) {
+                $mocked{$name} = "$file:$.";
+            }
+        }
+    }
+
+    close FH
+}

build-aux/prohibit-duplicate-header.pl

@@ -0,0 +1,26 @@
+#!/usr/bin/env perl
+
+use strict;
+
+my $file = " ";
+my $ret = 0;
+my %includes = ( );
+my $lineno = 0;
+
+while (<>) {
+    if (not $file eq $ARGV) {
+        %includes = ( );
+        $file = $ARGV;
+        $lineno = 0;
+    }
+    $lineno++;
+    if (/^# *include *[<"]([^>"]*\.h)[">]/) {
+        $includes{$1}++;
+        if ($includes{$1} == 2) {
+            $ret = 1;
+            print STDERR "$ARGV:$lineno: $_";
+            print STDERR "Do not include a header more than once per file\n";
+        }
+    }
+}
+exit $ret;

build-aux/useless-if-before-free

@@ -1,226 +0,0 @@
-#!/bin/sh
-#! -*-perl-*-
-
-# Detect instances of "if (p) free (p);".
-# Likewise "if (p != 0)", "if (0 != p)", or with NULL; and with braces.
-
-# Copyright (C) 2008-2019 Free Software Foundation, Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program 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 General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-#
-# Written by Jim Meyering
-
-# This is a prologue that allows to run a perl script as an executable
-# on systems that are compliant to a POSIX version before POSIX:2017.
-# On such systems, the usual invocation of an executable through execlp()
-# or execvp() fails with ENOEXEC if it is a script that does not start
-# with a #! line.  The script interpreter mentioned in the #! line has
-# to be /bin/sh, because on GuixSD systems that is the only program that
-# has a fixed file name.  The second line is essential for perl and is
-# also useful for editing this file in Emacs.  The next two lines below
-# are valid code in both sh and perl.  When executed by sh, they re-execute
-# the script through the perl program found in $PATH.  The '-x' option
-# is essential as well; without it, perl would re-execute the script
-# through /bin/sh.  When executed by  perl, the next two lines are a no-op.
-eval 'exec perl -wSx "$0" "$@"'
-     if 0;
-
-my $VERSION = '2018-03-07 03:47'; # UTC
-# The definition above must lie within the first 8 lines in order
-# for the Emacs time-stamp write hook (at end) to update it.
-# If you change this file with Emacs, please let the write hook
-# do its job.  Otherwise, update this string manually.
-
-use strict;
-use warnings;
-use Getopt::Long;
-
-(my $ME = $0) =~ s|.*/||;
-
-# use File::Coda; # https://meyering.net/code/Coda/
-END {
-  defined fileno STDOUT or return;
-  close STDOUT and return;
-  warn "$ME: failed to close standard output: $!\n";
-  $? ||= 1;
-}
-
-sub usage ($)
-{
-  my ($exit_code) = @_;
-  my $STREAM = ($exit_code == 0 ? *STDOUT : *STDERR);
-  if ($exit_code != 0)
-    {
-      print $STREAM "Try '$ME --help' for more information.\n";
-    }
-  else
-    {
-      print $STREAM <<EOF;
-Usage: $ME [OPTIONS] FILE...
-
-Detect any instance in FILE of a useless "if" test before a free call, e.g.,
-"if (p) free (p);".  Any such test may be safely removed without affecting
-the semantics of the C code in FILE.  Use --name=FOO --name=BAR to also
-detect free-like functions named FOO and BAR.
-
-OPTIONS:
-
-   --list       print only the name of each matching FILE (\\0-terminated)
-   --name=N     add name N to the list of \'free\'-like functions to detect;
-                  may be repeated
-
-   --help       display this help and exit
-   --version    output version information and exit
-
-Exit status:
-
-  0   one or more matches
-  1   no match
-  2   an error
-
-EXAMPLE:
-
-For example, this command prints all removable "if" tests before "free"
-and "kfree" calls in the linux kernel sources:
-
-    git ls-files -z |xargs -0 $ME --name=kfree
-
-EOF
-    }
-  exit $exit_code;
-}
-
-sub is_NULL ($)
-{
-  my ($expr) = @_;
-  return ($expr eq 'NULL' || $expr eq '0');
-}
-
-{
-  sub EXIT_MATCH {0}
-  sub EXIT_NO_MATCH {1}
-  sub EXIT_ERROR {2}
-  my $err = EXIT_NO_MATCH;
-
-  my $list;
-  my @name = qw(free);
-  GetOptions
-    (
-     help => sub { usage 0 },
-     version => sub { print "$ME version $VERSION\n"; exit },
-     list => \$list,
-     'name=s@' => \@name,
-    ) or usage 1;
-
-  # Make sure we have the right number of non-option arguments.
-  # Always tell the user why we fail.
-  @ARGV < 1
-    and (warn "$ME: missing FILE argument\n"), usage EXIT_ERROR;
-
-  my $or = join '|', @name;
-  my $regexp = qr/(?:$or)/;
-
-  # Set the input record separator.
-  # Note: this makes it impractical to print line numbers.
-  $/ = '"';
-
-  my $found_match = 0;
- FILE:
-  foreach my $file (@ARGV)
-    {
-      open FH, '<', $file
-        or (warn "$ME: can't open '$file' for reading: $!\n"),
-          $err = EXIT_ERROR, next;
-      while (defined (my $line = <FH>))
-        {
-          # Skip non-matching lines early to save time
-          $line =~ /\bif\b/
-            or next;
-          while ($line =~
-              /\b(if\s*\(\s*([^)]+?)(?:\s*!=\s*([^)]+?))?\s*\)
-              #  1          2                  3
-               (?:   \s*$regexp\s*\((?:\s*\([^)]+\))?\s*([^)]+)\)\s*;|
-                \s*\{\s*$regexp\s*\((?:\s*\([^)]+\))?\s*([^)]+)\)\s*;\s*\}))/sxg)
-            {
-              my $all = $1;
-              my ($lhs, $rhs) = ($2, $3);
-              my ($free_opnd, $braced_free_opnd) = ($4, $5);
-              my $non_NULL;
-              if (!defined $rhs) { $non_NULL = $lhs }
-              elsif (is_NULL $rhs) { $non_NULL = $lhs }
-              elsif (is_NULL $lhs) { $non_NULL = $rhs }
-              else { next }
-
-              # Compare the non-NULL part of the "if" expression and the
-              # free'd expression, without regard to white space.
-              $non_NULL =~ tr/ \t//d;
-              my $e2 = defined $free_opnd ? $free_opnd : $braced_free_opnd;
-              $e2 =~ tr/ \t//d;
-              if ($non_NULL eq $e2)
-                {
-                  $found_match = 1;
-                  $list
-                    and (print "$file\0"), next FILE;
-                  print "$file: $all\n";
-                }
-            }
-        }
-    }
-  continue
-    {
-      close FH;
-    }
-
-  $found_match && $err == EXIT_NO_MATCH
-    and $err = EXIT_MATCH;
-
-  exit $err;
-}
-
-my $foo = <<'EOF';
-# The above is to *find* them.
-# This adjusts them, removing the unnecessary "if (p)" part.
-
-# FIXME: do something like this as an option (doesn't do braces):
-free=xfree
-git grep -l -z "$free *(" \
-  | xargs -0 useless-if-before-free -l --name="$free" \
-  | xargs -0 perl -0x3b -pi -e \
-   's/\bif\s*\(\s*(\S+?)(?:\s*!=\s*(?:0|NULL))?\s*\)\s+('"$free"'\s*\((?:\s*\([^)]+\))?\s*\1\s*\)\s*;)/$2/s'
-
-# Use the following to remove redundant uses of kfree inside braces.
-# Note that -0777 puts perl in slurp-whole-file mode;
-# but we have plenty of memory, these days...
-free=kfree
-git grep -l -z "$free *(" \
-  | xargs -0 useless-if-before-free -l --name="$free" \
-  | xargs -0 perl -0777 -pi -e \
-     's/\bif\s*\(\s*(\S+?)(?:\s*!=\s*(?:0|NULL))?\s*\)\s*\{\s*('"$free"'\s*\((?:\s*\([^)]+\))?\s*\1\s*\);)\s*\}[^\n]*$/$2/gms'
-
-Be careful that the result of the above transformation is valid.
-If the matched string is followed by "else", then obviously, it won't be.
-
-When modifying files, refuse to process anything other than a regular file.
-EOF
-
-## Local Variables:
-## mode: perl
-## indent-tabs-mode: nil
-## eval: (add-hook 'before-save-hook 'time-stamp)
-## time-stamp-line-limit: 50
-## time-stamp-start: "my $VERSION = '"
-## time-stamp-format: "%:y-%02m-%02d %02H:%02M"
-## time-stamp-time-zone: "UTC0"
-## time-stamp-end: "'; # UTC"
-## End:

build-aux/vc-list-files

@@ -1,113 +0,0 @@
-#!/bin/sh
-# List version-controlled file names.
-
-# Print a version string.
-scriptversion=2018-03-07.03; # UTC
-
-# Copyright (C) 2006-2019 Free Software Foundation, Inc.
-
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-
-# This program 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 General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-
-# List the specified version-controlled files.
-# With no argument, list them all.  With a single DIRECTORY argument,
-# list the version-controlled files in that directory.
-
-# If there's an argument, it must be a single, "."-relative directory name.
-# cvsu is part of the cvsutils package: http://www.red-bean.com/cvsutils/
-
-postprocess=
-case $1 in
-  --help) cat <<EOF
-Usage: $0 [-C SRCDIR] [DIR...]
-
-Output a list of version-controlled files in DIR (default .), relative to
-SRCDIR (default .).  SRCDIR must be the top directory of a checkout.
-
-Options:
-  --help     print this help, then exit
-  --version  print version number, then exit
-  -C SRCDIR  change directory to SRCDIR before generating list
-
-Report bugs and patches to <bug-gnulib@gnu.org>.
-EOF
-    exit ;;
-
-  --version)
-    year=`echo "$scriptversion" | sed 's/[^0-9].*//'`
-    cat <<EOF
-vc-list-files $scriptversion
-Copyright (C) $year Free Software Foundation, Inc,
-License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law.
-EOF
-    exit ;;
-
-  -C)
-    test "$2" = . || postprocess="| sed 's|^|$2/|'"
-    cd "$2" || exit 1
-    shift; shift ;;
-esac
-
-test $# = 0 && set .
-
-for dir
-do
-  if test -d .git || test -f .git; then
-    test "x$dir" = x. \
-      && dir= sed_esc= \
-      || { dir="$dir/"; sed_esc=`echo "$dir"|env sed 's,\([\\/]\),\\\\\1,g'`; }
-    # Ignore git symlinks - either they point into the tree, in which case
-    # we don't need to visit the target twice, or they point somewhere
-    # else (often into a submodule), in which case the content does not
-    # belong to this package.
-    eval exec git ls-tree -r 'HEAD:"$dir"' \
-      \| sed -n '"s/^100[^	]*./$sed_esc/p"' $postprocess
-  elif test -d .hg; then
-    eval exec hg locate '"$dir/*"' $postprocess
-  elif test -d .bzr; then
-    test "$postprocess" = '' && postprocess="| sed 's|^\./||'"
-    eval exec bzr ls -R --versioned '"$dir"' $postprocess
-  elif test -d CVS; then
-    test "$postprocess" = '' && postprocess="| sed 's|^\./||'"
-    if test -x build-aux/cvsu; then
-      eval build-aux/cvsu --find --types=AFGM '"$dir"' $postprocess
-    elif (cvsu --help) >/dev/null 2>&1; then
-      eval cvsu --find --types=AFGM '"$dir"' $postprocess
-    else
-      eval awk -F/ \''{			\
-          if (!$1 && $3 !~ /^-/) {	\
-            f=FILENAME;			\
-            if (f ~ /CVS\/Entries$/)	\
-              f = substr(f, 1, length(f)-11); \
-            print f $2;			\
-          }}'\''				\
-        `find "$dir" -name Entries -print` /dev/null' $postprocess
-    fi
-  elif test -d .svn; then
-    eval exec svn list -R '"$dir"' $postprocess
-  else
-    echo "$0: Failed to determine type of version control used in `pwd`" 1>&2
-    exit 1
-  fi
-done
-
-# Local variables:
-# eval: (add-hook 'before-save-hook 'time-stamp)
-# time-stamp-start: "scriptversion="
-# time-stamp-format: "%:y-%02m-%02d.%02H"
-# time-stamp-time-zone: "UTC0"
-# time-stamp-end: "; # UTC"
-# End:

ci/Makefile

@@ -1,268 +0,0 @@
-# -*- makefile -*-
-# vim: filetype=make
-
-# The root directory of the libvirt.git checkout
-CI_GIT_ROOT = $(shell git rev-parse --show-toplevel)
-
-# The root directory for all CI-related contents
-CI_ROOTDIR = $(CI_GIT_ROOT)/ci
-
-# The directory holding content on the host that we will
-# expose to the container.
-CI_SCRATCHDIR = $(CI_ROOTDIR)/scratch
-
-# The directory holding the clone of the git repo that
-# we will expose to the container
-CI_HOST_SRCDIR = $(CI_SCRATCHDIR)/src
-
-# The directory holding the source inside the
-# container, i.e. where we want to expose
-# the $(CI_HOST_SRCDIR) directory from the host
-CI_CONT_SRCDIR = $(CI_USER_HOME)/libvirt
-
-# Relative directory to perform the build in. This
-# defaults to using a separate build dir, but can be
-# set to empty string for an in-source tree build.
-CI_VPATH = build
-
-# The directory holding the build output inside the
-# container.
-CI_CONT_BUILDDIR = $(CI_CONT_SRCDIR)/$(CI_VPATH)
-
-# Can be overridden with mingw{32,64}-configure if desired
-CI_CONFIGURE = $(CI_CONT_SRCDIR)/configure
-
-# Default to using all possible CPUs
-CI_SMP = $(shell getconf _NPROCESSORS_ONLN)
-
-# Any extra arguments to pass to make
-CI_MAKE_ARGS =
-
-# Any extra arguments to pass to configure
-CI_CONFIGURE_ARGS =
-
-# Script containing environment preparation steps
-CI_PREPARE_SCRIPT = $(CI_ROOTDIR)/prepare.sh
-
-# Script containing build instructions
-CI_BUILD_SCRIPT = $(CI_ROOTDIR)/build.sh
-
-# Location of the container images we're going to pull
-# Can be useful to overridde to use a locally built
-# image instead
-CI_IMAGE_PREFIX = quay.io/libvirt/buildenv-libvirt-
-
-# The default tag is ':latest' but if the container
-# repo above uses different conventions this can override it
-CI_IMAGE_TAG = :latest
-
-# We delete the virtual root after completion, set
-# to 0 if you need to keep it around for debugging
-CI_CLEAN = 1
-
-# We'll always freshly clone the virtual root each
-# time in case it was not cleaned up before. Set
-# to 1 if you want to try restarting a previously
-# preserved env
-CI_REUSE = 0
-
-# We need the container process to run with current host IDs
-# so that it can access the passed in build directory
-CI_UID = $(shell id -u)
-CI_GID = $(shell id -g)
-
-# We also need the user's login and home directory to prepare the
-# environment the way some programs expect it
-CI_USER_LOGIN = $(shell echo "$$USER")
-CI_USER_HOME = $(shell echo "$$HOME")
-
-CI_ENGINE = auto
-# Container engine we are going to use, can be overridden per make
-# invocation, if it is not we try podman and then default to docker.
-ifeq ($(CI_ENGINE),auto)
-	override CI_ENGINE = $(shell podman version >/dev/null 2>&1 && echo podman || echo docker)
-endif
-
-# IDs you run as do not need to exist in
-# the container's /etc/passwd & /etc/group files, but
-# if they do not, then libvirt's 'make check' will fail
-# many tests.
-
-# We do not directly mount /etc/{passwd,group} as Docker
-# is liable to mess with SELinux labelling which will
-# then prevent the host accessing them. And podman cannot
-# relabel the files due to it running rootless. So
-# copying them first is safer and less error-prone.
-CI_PWDB_MOUNTS = \
-	--volume $(CI_SCRATCHDIR)/group:/etc/group:ro,z \
-	--volume $(CI_SCRATCHDIR)/passwd:/etc/passwd:ro,z \
-	$(NULL)
-
-CI_HOME_MOUNTS = \
-	--volume $(CI_SCRATCHDIR)/home:$(CI_USER_HOME):z \
-	$(NULL)
-
-CI_SCRIPT_MOUNTS = \
-	--volume $(CI_SCRATCHDIR)/prepare:$(CI_USER_HOME)/prepare:z \
-	--volume $(CI_SCRATCHDIR)/build:$(CI_USER_HOME)/build:z \
-	$(NULL)
-
-# Docker containers can have very large ulimits
-# for nofiles - as much as 1048576. This makes
-# libvirt very slow at exec'ing programs.
-CI_ULIMIT_FILES = 1024
-
-ifeq ($(CI_ENGINE),podman)
-	# Podman cannot reuse host namespace when running non-root
-	# containers.  Until support for --keep-uid is added we can
-	# just create another mapping that will do that for us.
-	# Beware, that in {uid,git}map=container_id:host_id:range, the
-	# host_id does actually refer to the uid in the first mapping
-	# where 0 (root) is mapped to the current user and rest is
-	# offset.
-	#
-	# In order to set up this mapping, we need to keep all the
-	# user IDs to prevent possible errors as some images might
-	# expect UIDs up to 90000 (looking at you fedora), so we don't
-	# want the overflowuid to be used for them.  For mapping all
-	# the other users properly, some math needs to be done.
-	# Don't worry, it's just addition and subtraction.
-	#
-	# 65536 ought to be enough (tm), but for really rare cases the
-	# maximums might need to be higher, but that only happens when
-	# your /etc/sub{u,g}id allow users to have more IDs.  Unless
-	# --keep-uid is supported, let's do this in a way that should
-	# work for everyone.
-	CI_MAX_UID = $(shell sed -n "s/^$(CI_USER_LOGIN):[^:]\+://p" /etc/subuid)
-	CI_MAX_GID = $(shell sed -n "s/^$(CI_USER_LOGIN):[^:]\+://p" /etc/subgid)
-	ifeq ($(CI_MAX_UID),)
-		CI_MAX_UID = 65536
-	endif
-	ifeq ($(CI_MAX_GID),)
-		CI_MAX_GID = 65536
-	endif
-	CI_UID_OTHER = $(shell echo $$(($(CI_UID)+1)))
-	CI_GID_OTHER = $(shell echo $$(($(CI_GID)+1)))
-	CI_UID_OTHER_RANGE = $(shell echo $$(($(CI_MAX_UID)-$(CI_UID))))
-	CI_GID_OTHER_RANGE = $(shell echo $$(($(CI_MAX_GID)-$(CI_GID))))
-
-	CI_PODMAN_ARGS = \
-		--uidmap 0:1:$(CI_UID) \
-		--uidmap $(CI_UID):0:1 \
-		--uidmap $(CI_UID_OTHER):$(CI_UID_OTHER):$(CI_UID_OTHER_RANGE) \
-		--gidmap 0:1:$(CI_GID) \
-		--gidmap $(CI_GID):0:1 \
-		--gidmap $(CI_GID_OTHER):$(CI_GID_OTHER):$(CI_GID_OTHER_RANGE) \
-		$(NULL)
-endif
-
-# Args to use when cloning a git repo.
-#  -c  stop it complaining about checking out a random hash
-#  -q  stop it displaying progress info for local clone
-#  --local ensure we don't actually copy files
-CI_GIT_ARGS = \
-	-c advice.detachedHead=false \
-	-q \
-	--local  \
-	$(NULL)
-
-# Args to use when running the container
-#   --rm      stop inactive containers getting left behind
-#   --user    we execute as the same user & group account
-#             as dev so that file ownership matches host
-#             instead of root:root
-#   --volume  to pass in the cloned git repo & config
-#   --ulimit  lower files limit for performance reasons
-#   --interactive
-#   --tty     Ensure we have ability to Ctrl-C the build
-CI_ENGINE_ARGS = \
-	--rm \
-	--interactive \
-	--tty \
-	$(CI_PODMAN_ARGS) \
-	$(CI_PWDB_MOUNTS) \
-	$(CI_HOME_MOUNTS) \
-	$(CI_SCRIPT_MOUNTS) \
-	--volume $(CI_HOST_SRCDIR):$(CI_CONT_SRCDIR):z \
-	--ulimit nofile=$(CI_ULIMIT_FILES):$(CI_ULIMIT_FILES) \
-	--cap-add=SYS_PTRACE \
-	$(NULL)
-
-ci-check-engine:
-	@echo -n "Checking if $(CI_ENGINE) is available..." && \
-	$(CI_ENGINE) version 1>/dev/null && echo "yes"
-
-ci-prepare-tree: ci-check-engine
-	@test "$(CI_REUSE)" != "1" && rm -rf $(CI_SCRATCHDIR) || :
-	@if ! test -d $(CI_SCRATCHDIR) ; then \
-		mkdir -p $(CI_SCRATCHDIR); \
-		cp /etc/passwd $(CI_SCRATCHDIR); \
-		cp /etc/group $(CI_SCRATCHDIR); \
-		mkdir -p $(CI_SCRATCHDIR)/home; \
-		cp "$(CI_PREPARE_SCRIPT)" $(CI_SCRATCHDIR)/prepare; \
-		cp "$(CI_BUILD_SCRIPT)" $(CI_SCRATCHDIR)/build; \
-		chmod +x "$(CI_SCRATCHDIR)/prepare" "$(CI_SCRATCHDIR)/build"; \
-		echo "Cloning $(CI_GIT_ROOT) to $(CI_HOST_SRCDIR)"; \
-		git clone $(CI_GIT_ARGS) $(CI_GIT_ROOT) $(CI_HOST_SRCDIR) || exit 1; \
-		for mod in $$(git submodule | awk '{ print $$2 }' | sed -E 's,^../,,g') ; \
-		do \
-			test -f $(CI_GIT_ROOT)/$$mod/.git || continue ; \
-			echo "Cloning $(CI_GIT_ROOT)/$$mod to $(CI_HOST_SRCDIR)/$$mod"; \
-			git clone $(CI_GIT_ARGS) $(CI_GIT_ROOT)/$$mod $(CI_HOST_SRCDIR)/$$mod || exit 1; \
-		done ; \
-	fi
-
-ci-run-command@%: ci-prepare-tree
-	$(CI_ENGINE) run $(CI_ENGINE_ARGS) $(CI_IMAGE_PREFIX)$*$(CI_IMAGE_TAG) \
-		/bin/bash -c ' \
-		$(CI_USER_HOME)/prepare || exit 1; \
-		sudo \
-		  --login \
-		  --user="#$(CI_UID)" \
-		  --group="#$(CI_GID)" \
-		  CI_CONT_SRCDIR="$(CI_CONT_SRCDIR)" \
-		  CI_CONT_BUILDDIR="$(CI_CONT_BUILDDIR)" \
-		  CI_SMP="$(CI_SMP)" \
-		  CI_CONFIGURE="$(CI_CONFIGURE)" \
-		  CI_CONFIGURE_ARGS="$(CI_CONFIGURE_ARGS)" \
-		  CI_MAKE_ARGS="$(CI_MAKE_ARGS)" \
-		  $(CI_COMMAND) || exit 1'
-	@test "$(CI_CLEAN)" = "1" && rm -rf $(CI_SCRATCHDIR) || :
-
-ci-shell@%:
-	$(MAKE) -C $(CI_ROOTDIR) ci-run-command@$* CI_COMMAND="/bin/bash"
-
-ci-build@%:
-	$(MAKE) -C $(CI_ROOTDIR) ci-run-command@$* CI_COMMAND="$(CI_USER_HOME)/build"
-
-ci-check@%:
-	$(MAKE) -C $(CI_ROOTDIR) ci-build@$* CI_MAKE_ARGS="check"
-
-ci-list-images:
-	@echo
-	@echo "Available x86 container images:"
-	@echo
-	@sh list-images.sh "$(CI_ENGINE)" "$(CI_IMAGE_PREFIX)" | grep -v cross
-	@echo
-	@echo "Available cross-compiler container images:"
-	@echo
-	@sh list-images.sh "$(CI_ENGINE)" "$(CI_IMAGE_PREFIX)" | grep cross
-	@echo
-
-ci-help:
-	@echo "Build libvirt inside containers used for CI"
-	@echo
-	@echo "Available targets:"
-	@echo
-	@echo "    ci-build@\$$IMAGE - run a default 'make'"
-	@echo "    ci-check@\$$IMAGE - run a 'make check'"
-	@echo "    ci-shell@\$$IMAGE - run an interactive shell"
-	@echo "    ci-list-images  - list available images"
-	@echo "    ci-help         - show this help message"
-	@echo
-	@echo "Available make variables:"
-	@echo
-	@echo "    CI_CLEAN=0     - do not delete '$(CI_SCRATCHDIR)' after completion"
-	@echo "    CI_REUSE=1     - re-use existing '$(CI_SCRATCHDIR)' content"
-	@echo "    CI_ENGINE=auto - container engine to use (podman, docker)"
-	@echo

ci/build.sh

@@ -1,40 +0,0 @@
-# This script is used to build libvirt inside the container.
-#
-# You can customize it to your liking, or alternatively use a
-# completely different script by passing
-#
-#  CI_BUILD_SCRIPT=/path/to/your/build/script
-#
-# to make.
-
-mkdir -p "$CI_CONT_BUILDDIR" || exit 1
-cd "$CI_CONT_BUILDDIR"
-
-export VIR_TEST_DEBUG=1
-NOCONFIGURE=1 "$CI_CONT_SRCDIR/autogen.sh" || exit 1
-
-# $CONFIGURE_OPTS is a env that can optionally be set in the container,
-# populated at build time from the Dockerfile. A typical use case would
-# be to pass --host/--target args to trigger cross-compilation
-#
-# This can be augmented by make local args in $CI_CONFIGURE_ARGS
-"$CI_CONFIGURE" $CONFIGURE_OPTS $CI_CONFIGURE_ARGS
-if test $? != 0; then
-    test -f config.log && cat config.log
-    exit 1
-fi
-find -name test-suite.log -delete
-
-# gl_public_submodule_commit= to disable gnulib's submodule check
-# which breaks due to way we clone the submodules
-make -j"$CI_SMP" gl_public_submodule_commit= $CI_MAKE_ARGS
-
-if test $? != 0; then \
-    LOGS=$(find -name test-suite.log)
-    if test "$LOGS"; then
-        echo "=== LOG FILE(S) START ==="
-        cat $LOGS
-        echo "=== LOG FILE(S) END ==="
-    fi
-    exit 1
-fi

ci/list-images.sh

@@ -1,26 +0,0 @@
-#!/bin/sh
-
-engine="$1"
-prefix="$2"
-
-do_podman() {
-    # Podman freaks out if the search term ends with a dash, which ours
-    # by default does, so let's strip it. The repository name is the
-    # second field in the output, and it already starts with the registry
-    podman search --limit 100 "${prefix%-}" | while read _ repo _; do
-        echo "$repo"
-    done
-}
-
-do_docker() {
-    # Docker doesn't include the registry name in the output, so we have
-    # to add it. The repository name is the first field in the output
-    registry="${prefix%%/*}"
-    docker search --limit 100 "$prefix" | while read repo _; do
-        echo "$registry/$repo"
-    done
-}
-
-"do_$engine" | grep "^$prefix" | sed "s,^$prefix,,g" | while read repo; do
-    echo "    $repo"
-done | sort -u

ci/prepare.sh

@@ -1,13 +0,0 @@
-# This script is used to prepare the environment that will be used
-# to build libvirt inside the container.
-#
-# You can customize it to your liking, or alternatively use a
-# completely different script by passing
-#
-#  CI_PREPARE_SCRIPT=/path/to/your/prepare/script
-#
-# to make.
-#
-# Note that this script will have root privileges inside the
-# container, so it can be used for things like installing additional
-# packages.

config-post.h

@@ -16,8 +16,64 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/*
+ * Since virt-login-shell will be setuid, we must do everything
+ * we can to avoid linking to other libraries. Many of them do
+ * unsafe things in functions marked __attribute__((constructor)).
+ * The only way to avoid such deps is to re-compile the
+ * functions with the code in question disabled, and for that we
+ * must override the main config.h rules. Hence this file :-(
+ */
+
+#ifdef LIBVIRT_SETUID_RPC_CLIENT
+# undef HAVE_LIBNL
+# undef HAVE_LIBNL3
+# undef HAVE_LIBSASL2
+# undef HAVE_SYS_ACL_H
+# undef WITH_CAPNG
+# undef WITH_CURL
+# undef WITH_DBUS
+# undef WITH_DEVMAPPER
+# undef WITH_DTRACE_PROBES
+# undef WITH_GNUTLS
+# undef WITH_LIBSSH
+# undef WITH_MACVTAP
+# undef WITH_NUMACTL
+# undef WITH_SASL
+# undef WITH_SSH2
+# undef WITH_SYSTEMD_DAEMON
+# undef WITH_VIRTUALPORT
+# undef WITH_YAJL
+# undef WITH_YAJL2
+#endif
+
+/*
+ * With the NSS module it's the same story as virt-login-shell. See the
+ * explanation above.
+ */
+#ifdef LIBVIRT_NSS
+# undef HAVE_LIBNL
+# undef HAVE_LIBNL3
+# undef HAVE_LIBSASL2
+# undef HAVE_SYS_ACL_H
+# undef WITH_CAPNG
+# undef WITH_CURL
+# undef WITH_DEVMAPPER
+# undef WITH_DTRACE_PROBES
+# undef WITH_GNUTLS
+# undef WITH_LIBSSH
+# undef WITH_MACVTAP
+# undef WITH_NUMACTL
+# undef WITH_SASL
+# undef WITH_SSH2
+# undef WITH_VIRTUALPORT
+# undef WITH_SECDRIVER_SELINUX
+# undef WITH_SECDRIVER_APPARMOR
+# undef WITH_CAPNG
+#endif /* LIBVIRT_NSS */
+
 #ifndef __GNUC__
-# error "Libvirt requires GCC >= 4.8, or CLang"
+# error "Libvirt requires GCC >= 4.4, or CLang"
 #endif
 
 /*
@@ -32,30 +88,6 @@
     ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
 #endif
 
-#if defined(__clang_major__) && defined(__clang_minor__)
-# ifdef __apple_build_version__
-#  if __clang_major__ < 5 || (__clang_major__ == 5 && __clang_minor__ < 1)
-#   error You need at least XCode Clang v5.1 to compile QEMU
-#  endif
-# else
-#  if __clang_major__ < 3 || (__clang_major__ == 3 && __clang_minor__ < 4)
-#   error You need at least Clang v3.4 to compile QEMU
-#  endif
-# endif
-#elif defined(__GNUC__) && defined(__GNUC_MINOR__)
-# if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 8)
-#  error You need at least GCC v4.8 to compile QEMU
-# endif
-#else
-# error You either need at least GCC 4.8 or Clang 3.4 or XCode Clang 5.1 to compile libvirt
+#if !(__GNUC_PREREQ(4, 4) || defined(__clang__))
+# error "Libvirt requires GCC >= 4.4, or CLang"
 #endif
-
-/* Ask for warnings for anything that was marked deprecated in
- * the defined version, or before. It is a candidate for rewrite.
- */
-#define GLIB_VERSION_MIN_REQUIRED GLIB_VERSION_2_48
-
-/* Ask for warnings if code tries to use function that did not
- * exist in the defined version. These risk breaking builds
- */
-#define GLIB_VERSION_MAX_ALLOWED GLIB_VERSION_2_48

configure.ac

@@ -16,27 +16,15 @@ dnl You should have received a copy of the GNU Lesser General Public
 dnl License along with this library.  If not, see
 dnl <http://www.gnu.org/licenses/>.
 
-AC_INIT([libvirt], [6.0.0], [libvir-list@redhat.com], [], [https://libvirt.org])
-
-if test $srcdir = "."
-then
-  AC_MSG_ERROR([Build directory must be different from source directory])
-fi
-
+AC_INIT([libvirt], [5.0.0], [libvir-list@redhat.com], [], [https://libvirt.org])
 AC_CONFIG_SRCDIR([src/libvirt.c])
 AC_CONFIG_AUX_DIR([build-aux])
 AC_CONFIG_HEADERS([config.h])
 AH_BOTTOM([#include <config-post.h>])
 AC_CONFIG_MACRO_DIR([m4])
-dnl Make automake keep quiet about wildcards & other GNUmake-isms
-AM_INIT_AUTOMAKE([
-    foreign
-    -Wno-portability
-    tar-pax
-    no-dist-gzip
-    dist-xz
-    subdir-objects
-    ])
+dnl Make automake keep quiet about wildcards & other GNUmake-isms; also keep
+dnl quiet about the fact that we intentionally cater to automake 1.9
+AM_INIT_AUTOMAKE([-Wno-portability -Wno-obsolete tar-pax no-dist-gzip dist-xz subdir-objects])
 dnl older automake's default of ARFLAGS=cru is noisy on newer binutils;
 dnl we don't really need the 'u' even in older toolchains.  Then there is
 dnl older libtool, which spelled it AR_FLAGS
@@ -129,29 +117,12 @@ AC_PROG_CC
 AC_PROG_INSTALL
 AC_PROG_CPP
 
-dnl autoconf 2.70 adds a --runstatedir option so that downstreams
-dnl can point to /run instead of the historic /var/run, but
-dnl autoconf hasn't had a release since 2012.
-dnl
-dnl gnulib sets configmake.h to include runstatedir, but sets
-dnl it to $localstatedir/run if $runstatedir env var is not set
-dnl which is useless for apps that need to use /run without
-dnl waiting for autoconf 2.70
-dnl
-dnl we introduce --with-runstatedir and then overwrite the
-dnl value of $runstatedir so gnulib's configmake.h becomes useful
-AC_ARG_WITH(
-    [runstatedir],
-    [AS_HELP_STRING(
-        [--with-runstatedir],
-        [State directory for temporary sockets, pid files, etc])])
-
-if test -n "$with_runstatedir"
-then
-  runstatedir=$with_runstatedir
+dnl Setting AB_VERSION makes the 'autobuild' lines of configure output
+dnl slightly more useful
+if test -d $srcdir/.git && git --version >/dev/null 2>&1 ; then
+  AB_VERSION=`cd $srcdir && git describe --match 'v[[0-9]]*' 2>/dev/null`
 fi
 
-
 gl_EARLY
 gl_INIT
 
@@ -203,13 +174,13 @@ want_ifconfig=no
 dnl Make some notes about which OS we're compiling for, as the lxc and qemu
 dnl drivers require linux headers, and storage_mpath, dtrace, and nwfilter
 dnl are also linux specific.  The "network" and storage_fs drivers are known
-dnl to not work on macOS presently, so we also make a note if compiling
+dnl to not work on MacOS X presently, so we also make a note if compiling
 dnl for that
 
-with_linux=no with_macos=no with_freebsd=no with_win=no with_cygwin=no
+with_linux=no with_osx=no with_freebsd=no with_win=no with_cygwin=no
 case $host in
   *-*-linux*) with_linux=yes ;;
-  *-*-darwin*) with_macos=yes ;;
+  *-*-darwin*) with_osx=yes ;;
   *-*-freebsd*) with_freebsd=yes ;;
   *-*-mingw* | *-*-msvc* ) with_win=yes ;;
   *-*-cygwin*) with_cygwin=yes ;;
@@ -235,7 +206,6 @@ fi
 
 AM_CONDITIONAL([WITH_LINUX], [test "$with_linux" = "yes"])
 AM_CONDITIONAL([WITH_FREEBSD], [test "$with_freebsd" = "yes"])
-AM_CONDITIONAL([WITH_MACOS], [test "$with_macos" = "yes"])
 
 # We don't support the daemon yet
 if test "$with_win" = "yes" ; then
@@ -269,13 +239,13 @@ LIBVIRT_LINKER_NO_UNDEFINED
 LIBVIRT_ARG_APPARMOR
 LIBVIRT_ARG_ATTR
 LIBVIRT_ARG_AUDIT
+LIBVIRT_ARG_AVAHI
 LIBVIRT_ARG_BASH_COMPLETION
 LIBVIRT_ARG_BLKID
 LIBVIRT_ARG_CAPNG
 LIBVIRT_ARG_CURL
 LIBVIRT_ARG_DBUS
 LIBVIRT_ARG_FIREWALLD
-LIBVIRT_ARG_FIREWALLD_ZONE
 LIBVIRT_ARG_FUSE
 LIBVIRT_ARG_GLUSTER
 LIBVIRT_ARG_HAL
@@ -307,6 +277,7 @@ LIBVIRT_CHECK_APPARMOR
 LIBVIRT_CHECK_ATOMIC
 LIBVIRT_CHECK_ATTR
 LIBVIRT_CHECK_AUDIT
+LIBVIRT_CHECK_AVAHI
 LIBVIRT_CHECK_BASH_COMPLETION
 LIBVIRT_CHECK_BLKID
 LIBVIRT_CHECK_CAPNG
@@ -315,9 +286,7 @@ LIBVIRT_CHECK_DBUS
 LIBVIRT_CHECK_DEVMAPPER
 LIBVIRT_CHECK_DLOPEN
 LIBVIRT_CHECK_FIREWALLD
-LIBVIRT_CHECK_FIREWALLD_ZONE
 LIBVIRT_CHECK_FUSE
-LIBVIRT_CHECK_GLIB
 LIBVIRT_CHECK_GLUSTER
 LIBVIRT_CHECK_GNUTLS
 LIBVIRT_CHECK_HAL
@@ -362,7 +331,6 @@ AC_CHECK_FUNCS_ONCE([\
   getpwuid_r \
   getrlimit \
   getuid \
-  getutxid \
   if_indextoname \
   mmap \
   newlocale \
@@ -438,6 +406,19 @@ dnl
 
 LIBVIRT_CHECK_EXTERNAL_PROGRAMS
 
+
+dnl Specific dir for HTML output ?
+LIBVIRT_ARG_WITH([HTML_DIR], [path to base html directory],
+                 ['$(datadir)/doc'])
+LIBVIRT_ARG_WITH([HTML_SUBDIR], [directory used under html-dir],
+                 ['$(PACKAGE)-$(VERSION)/html'])
+if test "x$with_html_subdir" != "x" ; then
+  HTML_DIR="$with_html_dir/$with_html_subdir"
+else
+  HTML_DIR="$with_html_dir"
+fi
+AC_SUBST([HTML_DIR])
+
 dnl if --prefix is /usr, don't use /usr/var for localstatedir
 dnl or /usr/etc for sysconfdir
 dnl as this makes a lot of things break in testing situations
@@ -456,6 +437,8 @@ dnl
 LIBVIRT_DRIVER_ARG_QEMU
 LIBVIRT_DRIVER_ARG_OPENVZ
 LIBVIRT_DRIVER_ARG_VMWARE
+LIBVIRT_DRIVER_ARG_PHYP
+LIBVIRT_DRIVER_ARG_XENAPI
 LIBVIRT_DRIVER_ARG_LIBXL
 LIBVIRT_DRIVER_ARG_VBOX
 LIBVIRT_DRIVER_ARG_LXC
@@ -472,6 +455,8 @@ LIBVIRT_DRIVER_ARG_INTERFACE
 LIBVIRT_DRIVER_CHECK_QEMU
 LIBVIRT_DRIVER_CHECK_OPENVZ
 LIBVIRT_DRIVER_CHECK_VMWARE
+LIBVIRT_DRIVER_CHECK_PHYP
+LIBVIRT_DRIVER_CHECK_XENAPI
 LIBVIRT_DRIVER_CHECK_LIBXL
 LIBVIRT_DRIVER_CHECK_VBOX
 LIBVIRT_DRIVER_CHECK_LXC
@@ -485,6 +470,8 @@ LIBVIRT_DRIVER_CHECK_LIBVIRTD
 LIBVIRT_DRIVER_CHECK_NETWORK
 LIBVIRT_DRIVER_CHECK_INTERFACE
 
+AM_CONDITIONAL([WITH_XENCONFIG], [test "$with_libxl" = "yes"])
+
 
 dnl
 dnl in case someone want to build static binaries
@@ -532,6 +519,9 @@ dnl
 AC_CHECK_HEADERS([linux/kvm.h])
 
 
+AM_CONDITIONAL([WITH_SETUID_RPC_CLIENT], [test "$with_lxc$with_login_shell" != "nono"])
+
+
 dnl
 dnl check for kernel headers required by src/bridge.c
 dnl
@@ -629,9 +619,9 @@ if test "$with_libvirtd" = "no"; then
   with_storage_vstorage=no
 fi
 
-dnl storage-fs does not work on macOS
+dnl storage-fs does not work on MacOS X
 
-if test "$with_macos" = "yes"; then
+if test "$with_osx" = "yes"; then
   with_storage_fs=no
 fi
 
@@ -699,23 +689,10 @@ if test "$with_linux" = "yes"; then
 fi
 
 dnl Allow perl/python overrides
-AC_PATH_PROGS([PYTHON], [python3])
+AC_PATH_PROGS([PYTHON], [python3 python2 python])
 if test -z "$PYTHON"; then
-    AC_MSG_ERROR(['python3' binary is required to build libvirt])
+    AC_MSG_ERROR(['python3', 'python2' or 'python' binary is required to build libvirt])
 fi
-AC_DEFINE_UNQUOTED([PYTHON], "$PYTHON", [path to python binary])
-AC_PATH_PROG([FLAKE8], [flake8])
-if test -z "$FLAKE8"; then
-    AC_MSG_WARN(['flake8' binary is required to check python code style])
-fi
-
-dnl Python3 < 3.7 treats the C locale as 7-bit only.
-dnl We must force env vars so it treats it as UTF-8
-dnl regardless of the user's locale.
-RUNUTF8="LC_ALL= LANG=C LC_CTYPE=en_US.UTF-8"
-AC_SUBST(RUNUTF8)
-
-
 AC_PATH_PROG([PERL], [perl])
 if test -z "$PERL"; then
          AC_MSG_ERROR(['perl' binary is required to build libvirt])
@@ -776,6 +753,34 @@ if test "$enable_test_coverage" = yes; then
   WARN_CFLAGS=$save_WARN_CFLAGS
 fi
 
+LIBVIRT_ARG_ENABLE([TEST_OOM], [memory allocation failure checking], [no])
+case "$enable_test_oom" in
+  yes|no) ;;
+  *) AC_MSG_ERROR([bad value ${enable_test_oom} for test-oom option]) ;;
+esac
+
+if test "$enable_test_oom" = yes; then
+  have_trace=yes
+  AC_CHECK_HEADER([execinfo.h],[],[have_trace=no])
+  AC_CHECK_FUNC([backtrace],[],[have_trace=no])
+  if test "$have_trace" = "yes"; then
+    AC_DEFINE([TEST_OOM_TRACE], 1, [Whether backtrace() is available])
+  fi
+  AC_DEFINE([TEST_OOM], 1, [Whether malloc OOM checking is enabled])
+fi
+
+LIBVIRT_ARG_ENABLE([TEST_LOCKING], [thread locking tests using CIL], [no])
+case "$enable_test_locking" in
+  yes|no) ;;
+  *) AC_MSG_ERROR([bad value ${enable_test_locking} for test-locking option]) ;;
+esac
+
+if test "$enable_test_locking" = "yes"; then
+  LOCK_CHECKING_CFLAGS="-save-temps"
+  AC_SUBST([LOCK_CHECKING_CFLAGS])
+fi
+AM_CONDITIONAL([WITH_CIL],[test "$enable_test_locking" = "yes"])
+
 dnl Cygwin, MinGW and MSVC checks
 LIBVIRT_WIN_CHECK_COMMON
 LIBVIRT_WIN_CHECK_CYGWIN
@@ -880,12 +885,6 @@ AC_CHECK_DECLS([clock_serv_t, host_get_clock_service, clock_get_time],
                 #include <mach/mach.h>
                ])
 
-# Check if we have new enough kernel to support BPF devices for cgroups v2
-if test "$with_linux" = "yes"; then
-    AC_CHECK_DECLS([BPF_PROG_QUERY, BPF_CGROUP_DEVICE],
-                   [], [], [#include <linux/bpf.h>])
-fi
-
 # Check if we need to look for ifconfig
 if test "$want_ifconfig" = "yes"; then
      AC_PATH_PROG([IFCONFIG_PATH], [ifconfig])
@@ -910,11 +909,10 @@ test "x$lv_cv_static_analysis" = xyes && t=1
 AC_DEFINE_UNQUOTED([STATIC_ANALYSIS], [$t],
   [Define to 1 when performing static analysis.])
 
-GNUmakefile=GNUmakefile
-m4_if(m4_version_compare([2.61a.100],
-        m4_defn([m4_PACKAGE_VERSION])), [1], [],
-      [AC_CONFIG_LINKS([$GNUmakefile:$GNUmakefile], [],
-        [GNUmakefile=$GNUmakefile])])
+# Some GNULIB base64 symbols clash with a kerberos library
+AC_DEFINE_UNQUOTED([isbase64],[libvirt_gl_isbase64],[Hack to avoid symbol clash])
+AC_DEFINE_UNQUOTED([base64_encode],[libvirt_gl_base64_encode],[Hack to avoid symbol clash])
+AC_DEFINE_UNQUOTED([base64_encode_alloc],[libvirt_gl_base64_encode_alloc],[Hack to avoid symbol clash])
 
 AC_CONFIG_FILES([run],
                 [chmod +x,-w run])
@@ -949,8 +947,10 @@ LIBVIRT_DRIVER_RESULT_QEMU
 LIBVIRT_DRIVER_RESULT_OPENVZ
 LIBVIRT_DRIVER_RESULT_VMWARE
 LIBVIRT_DRIVER_RESULT_VBOX
+LIBVIRT_DRIVER_RESULT_XENAPI
 LIBVIRT_DRIVER_RESULT_LIBXL
 LIBVIRT_DRIVER_RESULT_LXC
+LIBVIRT_DRIVER_RESULT_PHYP
 LIBVIRT_DRIVER_RESULT_ESX
 LIBVIRT_DRIVER_RESULT_HYPERV
 LIBVIRT_DRIVER_RESULT_VZ
@@ -992,6 +992,7 @@ LIBVIRT_RESULT_ACL
 LIBVIRT_RESULT_APPARMOR
 LIBVIRT_RESULT_ATTR
 LIBVIRT_RESULT_AUDIT
+LIBVIRT_RESULT_AVAHI
 LIBVIRT_RESULT_BASH_COMPLETION
 LIBVIRT_RESULT_BLKID
 LIBVIRT_RESULT_CAPNG
@@ -999,9 +1000,7 @@ LIBVIRT_RESULT_CURL
 LIBVIRT_RESULT_DBUS
 LIBVIRT_RESULT_DLOPEN
 LIBVIRT_RESULT_FIREWALLD
-LIBVIRT_RESULT_FIREWALLD_ZONE
 LIBVIRT_RESULT_FUSE
-LIBVIRT_RESULT_GLIB
 LIBVIRT_RESULT_GLUSTER
 LIBVIRT_RESULT_GNUTLS
 LIBVIRT_RESULT_HAL
@@ -1029,6 +1028,7 @@ LIBVIRT_RESULT_SSH2
 LIBVIRT_RESULT_UDEV
 LIBVIRT_RESULT_VIRTUALPORT
 LIBVIRT_RESULT_XDR
+LIBVIRT_RESULT_XENAPI
 LIBVIRT_RESULT_YAJL
 AC_MSG_NOTICE([])
 AC_MSG_NOTICE([Windows])
@@ -1038,13 +1038,14 @@ LIBVIRT_WIN_RESULT_WINDRES
 AC_MSG_NOTICE([])
 AC_MSG_NOTICE([Test suite])
 AC_MSG_NOTICE([])
-LIBVIRT_RESULT([Coverage], [$enable_test_coverage])
+AC_MSG_NOTICE([         Coverage: $enable_test_coverage])
+AC_MSG_NOTICE([        Alloc OOM: $enable_test_oom])
 AC_MSG_NOTICE([])
 AC_MSG_NOTICE([Miscellaneous])
 AC_MSG_NOTICE([])
 LIBVIRT_RESULT_DEBUG
-LIBVIRT_RESULT([Use -Werror], [$enable_werror])
-LIBVIRT_RESULT([Warning Flags], [$WARN_CFLAGS])
+AC_MSG_NOTICE([       Use -Werror: $enable_werror])
+AC_MSG_NOTICE([     Warning Flags: $WARN_CFLAGS])
 LIBVIRT_RESULT_DTRACE
 LIBVIRT_RESULT_NUMAD
 LIBVIRT_RESULT_INIT_SCRIPT

docs/Makefile.am

@@ -16,84 +16,26 @@
 ## License along with this library.  If not, see
 ## <http://www.gnu.org/licenses/>.
 
-HTML_DIR = $(docdir)/html
-
-modules = \
-	libvirt-common \
-	libvirt-domain \
-	libvirt-domain-checkpoint \
-	libvirt-domain-snapshot \
-	libvirt-event \
-	libvirt-host \
-	libvirt-interface \
-	libvirt-network \
-	libvirt-nodedev \
-	libvirt-nwfilter \
-	libvirt-secret \
-	libvirt-storage \
-	libvirt-stream \
-	virterror \
-	$(NULL)
-
-modules_admin = libvirt-admin
-modules_qemu = libvirt-qemu
-modules_lxc = libvirt-lxc
-
-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
-	@for file in $(css); \
-	do \
-	  test -e $$file || ln -s $(srcdir)/$$file $$file ; \
-	done
-
-clean-local:
-	for dir in fonts js logos; \
-	do \
-	  rm -f $$dir ; \
-	done
-	for file in $(css); \
-	do \
-	  rm -f $$file ; \
-	done
+DEVHELP_DIR=$(datadir)/gtk-doc/html/libvirt
 
 apihtml = \
   html/index.html \
   $(apihtml_generated)
 
 apihtml_generated = \
-	$(addprefix html/libvirt-,$(addsuffix .html,$(modules))) \
-	$(NULL)
-
-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)
+  html/libvirt-libvirt-common.html \
+  html/libvirt-libvirt-domain.html \
+  html/libvirt-libvirt-domain-snapshot.html \
+  html/libvirt-libvirt-event.html \
+  html/libvirt-libvirt-host.html \
+  html/libvirt-libvirt-interface.html \
+  html/libvirt-libvirt-network.html \
+  html/libvirt-libvirt-nodedev.html \
+  html/libvirt-libvirt-nwfilter.html \
+  html/libvirt-libvirt-secret.html \
+  html/libvirt-libvirt-storage.html \
+  html/libvirt-libvirt-stream.html \
+  html/libvirt-virterror.html
 
 apipng = \
   html/left.png \
@@ -101,8 +43,11 @@ apipng = \
   html/home.png \
   html/right.png
 
-apirefdir = $(HTML_DIR)/html
-apiref_DATA = $(apihtml) $(apiadminhtml) $(apiqemuhtml) $(apilxchtml) $(apipng)
+devhelphtml = \
+  devhelp/libvirt.devhelp \
+  devhelp/index.html \
+  devhelp/general.html \
+  devhelp/libvirt-virterror.html
 
 css = \
   generic.css \
@@ -110,13 +55,6 @@ css = \
   mobile.css \
   main.css
 
-javascript = \
-  js/main.js \
-  $(NULL)
-
-javascriptdir = $(HTML_DIR)/js
-javascript_DATA = $(javascript)
-
 fonts = \
   fonts/LICENSE.md \
   fonts/stylesheet.css \
@@ -131,8 +69,15 @@ fonts = \
   fonts/overpass-mono-semibold.woff \
   fonts/overpass-regular.woff
 
-fontsdir = $(HTML_DIR)/fonts
-fonts_DATA = $(fonts)
+devhelppng = \
+  devhelp/home.png \
+  devhelp/left.png \
+  devhelp/right.png \
+  devhelp/up.png
+
+devhelpcss = devhelp/style.css
+
+devhelpxsl = devhelp/devhelp.xsl devhelp/html.xsl
 
 logofiles = \
   logos/logo-base.svg \
@@ -153,9 +98,6 @@ logofiles = \
   logos/logo-banner-light-256.png \
   logos/logo-banner-light-800.png
 
-logofilesdir = $(HTML_DIR)/logos
-logofiles_DATA = $(logofiles)
-
 png = \
   32favicon.png \
   libvirt-daemon-arch.png \
@@ -171,157 +113,40 @@ gif = \
   architecture.gif \
   node.gif
 
+
 internals_html_in = \
   $(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/internals/*.html.in))
-internals_rst = \
-  $(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/internals/*.rst))
-internals_rst_html_in = \
-  $(internals_rst:%.rst=%.html.in)
-internals_html = \
-  $(internals_html_in:%.html.in=%.html) \
-  $(internals_rst_html_in:%.html.in=%.html)
-
-internalsdir = $(HTML_DIR)/internals
-internals_DATA = $(internals_html)
-
-kbase_html_in = \
-  $(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/kbase/*.html.in))
-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)
-
-kbasedir = $(HTML_DIR)/kbase
-kbase_DATA = $(kbase_html)
-
-# Sync with src/util/
-KEYCODES = linux osx atset1 atset2 atset3 xtkbd usb win32 qnum
-KEYNAMES = linux osx win32
-
-manpages_rst = \
-  manpages/index.rst \
-  $(NULL)
-manpages1_rst = \
-  manpages/virt-pki-validate.rst \
-  manpages/virt-xml-validate.rst \
-  manpages/virt-admin.rst \
-  manpages/virsh.rst \
-  $(NULL)
-manpages7_rst = \
-  $(KEYCODES:%=manpages/virkeycode-%.rst) \
-  $(KEYNAMES:%=manpages/virkeyname-%.rst) \
-  $(NULL)
-manpages8_rst = $(NULL)
-manpages_rst += \
-  $(manpages1_rst) \
-  $(manpages7_rst) \
-  $(manpages8_rst) \
-  $(NULL)
-if WITH_LIBVIRTD
-manpages8_rst += \
-  manpages/libvirtd.rst \
-  manpages/virtlockd.rst \
-  manpages/virtlogd.rst \
-  $(NULL)
-else ! WITH_LIBVIRTD
-manpages_rst += \
-  manpages/libvirtd.rst \
-  manpages/virtlockd.rst \
-  manpages/virtlogd.rst \
-  $(NULL)
-endif ! WITH_LIBVIRTD
-if WITH_HOST_VALIDATE
-  manpages1_rst += manpages/virt-host-validate.rst
-else ! WITH_HOST_VALIDATE
-  manpages_rst += manpages/virt-host-validate.rst
-endif ! WITH_HOST_VALIDATE
-if WITH_LOGIN_SHELL
-  manpages1_rst += manpages/virt-login-shell.rst
-else ! WITH_LOGIN_SHELL
-  manpages_rst += manpages/virt-login-shell.rst
-endif ! WITH_LOGIN_SHELL
-if WITH_SANLOCK
-  manpages8_rst += manpages/virt-sanlock-cleanup.rst
-else ! WITH_SANLOCK
-  manpages_rst += manpages/virt-sanlock-cleanup.rst
-endif ! WITH_SANLOCK
-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' | \
-	   $(RST2MAN) > $@ || { rm $@ && exit 1; }
-
-%.7: %.rst
-	$(AM_V_GEN)$(MKDIR_P) `dirname $@` && \
-	   grep -v '^\.\. contents::' < $< | \
-	   sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \
-	       -e 's|RUNSTATEDIR|$(runstatedir)|g' | \
-	   $(RST2MAN) > $@ || { rm $@ && exit 1; }
-
-%.8: %.rst
-	$(AM_V_GEN)$(MKDIR_P) `dirname $@` && \
-	   grep -v '^\.\. contents::' < $< | \
-	   sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \
-	       -e 's|RUNSTATEDIR|$(runstatedir)|g' | \
-	   $(RST2MAN) > $@ || { rm $@ && exit 1; }
-
-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 > $@
-
-manpagesdir = $(HTML_DIR)/manpages
-manpages_DATA = $(manpages_html)
+internals_html = $(internals_html_in:%.html.in=%.html)
 
+# Since we ship pre-built html in the tarball, we must also
+# ship the sources, even when those sources are themselves
+# generated.
 # Generate hvsupport.html and news.html first, since they take one extra step.
-dot_html_generated_in = \
-  hvsupport.html.in \
-  news.html.in
 dot_html_in = \
+  hvsupport.html.in \
+  news.html.in \
   $(notdir $(wildcard $(srcdir)/*.html.in))
-dot_rst = \
-  $(notdir $(wildcard $(srcdir)/*.rst))
-dot_rst_html_in = \
-  $(dot_rst:%.rst=%.html)
-dot_html = \
-  $(dot_html_generated_in:%.html.in=%.html) \
-  $(dot_html_in:%.html.in=%.html) \
-  $(dot_rst_html_in:%.html.in=%.html)
+dot_html = $(dot_html_in:%.html.in=%.html)
 
-htmldir = $(HTML_DIR)
-html_DATA = $(css) $(png) $(gif) $(dot_html)
+dot_php_in = $(notdir $(wildcard $(srcdir)/*.php.in))
+dot_php_code_in = $(dot_php_in:%.php.in=%.php.code.in)
+dot_php = $(dot_php_in:%.php.in=%.php)
+
+xml = \
+  libvirt-api.xml \
+  libvirt-refs.xml
+
+qemu_xml = \
+  libvirt-qemu-api.xml \
+  libvirt-qemu-refs.xml
+
+lxc_xml = \
+  libvirt-lxc-api.xml \
+  libvirt-lxc-refs.xml
+
+admin_xml = \
+  libvirt-admin-api.xml \
+  libvirt-admin-refs.xml
 
 apidir = $(pkgdatadir)/api
 api_DATA = \
@@ -344,39 +169,31 @@ schemadir = $(pkgdatadir)/schemas
 schema_DATA = $(wildcard $(srcdir)/schemas/*.rng)
 
 EXTRA_DIST= \
+  apibuild.py genaclperms.pl \
   site.xsl subsite.xsl newapi.xsl page.xsl \
   wrapstring.xsl \
-  $(dot_html_in) $(dot_rst) $(gif) $(apipng) \
-  $(fig) $(png) $(css) \
-  $(javascript) $(logofiles) \
-  $(internals_html_in) $(internals_rst) $(fonts) \
-  $(kbase_html_in) $(kbase_rst) \
-  $(manpages_rst) \
+  $(dot_html) $(dot_html_in) $(gif) $(apihtml) $(apipng) \
+  $(devhelphtml) $(devhelppng) $(devhelpcss) $(devhelpxsl) \
+  $(xml) $(qemu_xml) $(lxc_xml) $(admin_xml) $(fig) $(png) $(css) \
+  $(logofiles) $(dot_php_in) $(dot_php_code_in) $(dot_php)\
+  $(internals_html_in) $(internals_html) $(fonts) \
   aclperms.htmlinc \
+  hvsupport.pl \
   $(schema_DATA)
 
 acl_generated = aclperms.htmlinc
 
-aclperms.htmlinc: $(top_srcdir)/src/access/viraccessperm.h \
-        $(top_srcdir)/scripts/genaclperms.py Makefile.am
-	$(AM_V_GEN)$(RUNUTF8) $(PYTHON) $(top_srcdir)/scripts/genaclperms.py $< > $@
+$(srcdir)/aclperms.htmlinc: $(top_srcdir)/src/access/viraccessperm.h \
+        $(srcdir)/genaclperms.pl Makefile.am
+	$(AM_V_GEN)$(PERL) $(srcdir)/genaclperms.pl $< > $@
 
-CLEANFILES = \
-  $(dot_html) \
-  $(apihtml) \
-  $(apiadminhtml) \
-  $(apiqemuhtml) \
-  $(apilxchtml) \
-  $(internals_html) \
-  $(kbase_html) \
-  $(manpages_html) \
-  $(man1_MANS) \
-  $(man7_MANS) \
-  $(manpages7_rst) \
-  $(man8_MANS) \
-  $(api_DATA) \
-  $(dot_html_generated_in) \
-  aclperms.htmlinc
+MAINTAINERCLEANFILES = \
+  $(addprefix $(srcdir)/,$(dot_html)) \
+  $(addprefix $(srcdir)/,$(apihtml)) \
+  $(addprefix $(srcdir)/,$(devhelphtml)) \
+  $(addprefix $(srcdir)/,$(internals_html)) \
+  $(addprefix $(srcdir)/,$(dot_php)) \
+  $(srcdir)/hvsupport.html.in $(srcdir)/aclperms.htmlinc
 
 timestamp="$(shell if test -n "$$SOURCE_DATE_EPOCH"; \
 		   then \
@@ -385,42 +202,49 @@ timestamp="$(shell if test -n "$$SOURCE_DATE_EPOCH"; \
 		     date -u; \
 		   fi)"
 
-hvsupport.html: hvsupport.html.in
+all-am: web
 
-hvsupport.html.in: $(top_srcdir)/scripts/hvsupport.py $(api_DATA) \
+api: $(srcdir)/libvirt-api.xml $(srcdir)/libvirt-refs.xml
+qemu_api: $(srcdir)/libvirt-qemu-api.xml $(srcdir)/libvirt-qemu-refs.xml
+lxc_api: $(srcdir)/libvirt-lxc-api.xml $(srcdir)/libvirt-lxc-refs.xml
+admin_api: $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml
+
+web: $(dot_html) $(internals_html) html/index.html devhelp/index.html \
+  $(dot_php)
+
+hvsupport.html: $(srcdir)/hvsupport.html.in
+
+$(srcdir)/hvsupport.html.in: $(srcdir)/hvsupport.pl $(api_DATA) \
 		$(top_srcdir)/src/libvirt_public.syms \
 	$(top_srcdir)/src/libvirt_qemu.syms $(top_srcdir)/src/libvirt_lxc.syms \
 	$(top_srcdir)/src/driver.h
-	$(AM_V_GEN)$(RUNUTF8) $(PYTHON) $(top_srcdir)/scripts/hvsupport.py \
-		$(top_srcdir) $(top_builddir) > $@ || { rm $@ && exit 1; }
+	$(AM_V_GEN)$(PERL) $(srcdir)/hvsupport.pl $(top_srcdir)/src > $@ \
+		|| { rm $@ && exit 1; }
 
+# xsltproc seems to add the xmlns="" attribute to random output elements:
+# use sed to strip it out, as leaving it there triggers XML errors during
+# further transformation steps
 news.html.in: \
 	  $(srcdir)/news.xml \
 	  $(srcdir)/news-html.xsl
 	$(AM_V_GEN)$(XSLTPROC) --nonet \
 	    $(srcdir)/news-html.xsl \
 	    $(srcdir)/news.xml \
-	  >$@ \
-	    || { rm -f $@; exit 1; };
+	  >$@-tmp \
+	    || { rm -f $@-tmp; exit 1; }; \
+	  sed 's/ xmlns=""//g' $@-tmp >$@ \
+	    || { rm -f $@-tmp; exit 1; }; \
+	  rm -f $@-tmp
 EXTRA_DIST += \
 	$(srcdir)/news.xml \
 	$(srcdir)/news.rng \
 	$(srcdir)/news-html.xsl
+MAINTAINERCLEANFILES += \
+	$(srcdir)/news.html.in
 
 %.png: %.fig
 	convert -rotate 90 $< $@
 
-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' | \
-	  $(RST2HTML) > $@ || { rm $@ && exit 1; }
-
-%.html.in: %.rst
-	$(AM_V_GEN)$(MKDIR_P) `dirname $@` && \
-	  $(RST2HTML) $< > $@ || { rm $@ && exit 1; }
-
 %.html.tmp: %.html.in site.xsl subsite.xsl page.xsl \
 		$(acl_generated)
 	$(AM_V_GEN)name=`echo $@ | sed -e 's/.tmp//'`; \
@@ -433,56 +257,65 @@ manpages/%.html.in: manpages/%.rst
 	    style=subsite.xsl; \
 	  fi; \
 	  $(XSLTPROC) --stringparam pagename $$name \
-	    --stringparam builddir '$(abs_top_builddir)' \
 	    --stringparam timestamp $(timestamp) --nonet \
 	    $(top_srcdir)/docs/$$style $< > $@ \
 	    || { rm $@ && exit 1; }
 
 %.html: %.html.tmp
-	$(AM_V_GEN)$(XMLLINT) --nonet --format $< > $@ \
-	  || { rm $@ && exit 1; }
+	$(AM_V_GEN)$(XMLLINT) --nonet --format $< > $(srcdir)/$@ \
+	  || { rm $(srcdir)/$@ && exit 1; }
+
+%.php.tmp: %.php.in site.xsl page.xsl
+	$(AM_V_GEN)$(XSLTPROC) --stringparam pagename $(@:.tmp=) \
+	    --stringparam timestamp $(timestamp) --nonet \
+	    $(top_srcdir)/docs/site.xsl $< > $@ \
+	    || { rm $@ && exit 1; }
+
+%.php: %.php.tmp %.php.code.in
+	$(AM_V_GEN)sed \
+	    -e '/<span id="php_placeholder"><\/span>/r '"$(srcdir)/$@.code.in" \
+	    -e /php_placeholder/d < $@.tmp > $(srcdir)/$@ \
+	    || { rm $(srcdir)/$@ && exit 1; }
 
 $(apihtml_generated): html/index.html
-$(apiadminhtml_generated): html/index-admin.html
-$(apiqemuhtml_generated): html/index-qemu.html
-$(apilxchtml_generated): html/index-lxc.html
 
 html/index.html: libvirt-api.xml newapi.xsl page.xsl $(APIBUILD_STAMP)
-	$(AM_V_GEN)$(XSLTPROC) --nonet -o ./ \
+	$(AM_V_GEN)$(XSLTPROC) --nonet -o $(srcdir)/ \
 	  --stringparam builddir '$(abs_top_builddir)' \
 	  --stringparam timestamp $(timestamp) \
-	  $(srcdir)/newapi.xsl libvirt-api.xml
+	  $(srcdir)/newapi.xsl $(srcdir)/libvirt-api.xml && \
+	  $(XMLLINT) --nonet --noout $(srcdir)/html/*.html
 
-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/%=%) \
-	  $(srcdir)/newapi.xsl $<
+$(addprefix $(srcdir)/,$(devhelphtml)): $(srcdir)/libvirt-api.xml $(devhelpxsl)
+	$(AM_V_GEN)$(XSLTPROC) --stringparam timestamp $(timestamp) \
+	  --nonet -o $(srcdir)/devhelp/ \
+	  $(top_srcdir)/docs/devhelp/devhelp.xsl $(srcdir)/libvirt-api.xml
 
-check-html:
-	$(XMLLINT) --nonet --noout html/*.html
-
-check-local: check-html
 
 python_generated_files = \
-		html/libvirt-libvirt-lxc.html \
-		html/libvirt-libvirt-qemu.html \
-		html/libvirt-libvirt-admin.html \
-		html/libvirt-virterror.html \
-		$(api_DATA) \
+		$(srcdir)/html/libvirt-libvirt-lxc.html \
+		$(srcdir)/html/libvirt-libvirt-qemu.html \
+		$(srcdir)/html/libvirt-libvirt-admin.html \
+		$(srcdir)/html/libvirt-virterror.html \
+		$(srcdir)/libvirt-api.xml \
+		$(srcdir)/libvirt-refs.xml \
+		$(srcdir)/libvirt-lxc-api.xml \
+		$(srcdir)/libvirt-lxc-refs.xml \
+		$(srcdir)/libvirt-qemu-api.xml \
+		$(srcdir)/libvirt-qemu-refs.xml \
+		$(srcdir)/libvirt-admin-api.xml \
+		$(srcdir)/libvirt-admin-refs.xml \
 		$(NULL)
 
-APIBUILD=$(top_srcdir)/scripts/apibuild.py
-APIBUILD_STAMP=apibuild.py.stamp
-CLEANFILES += $(APIBUILD_STAMP)
+APIBUILD=$(srcdir)/apibuild.py
+APIBUILD_STAMP=$(APIBUILD).stamp
+EXTRA_DIST += $(APIBUILD_STAMP)
 
 $(python_generated_files): $(APIBUILD_STAMP)
 
-$(APIBUILD_STAMP): $(top_srcdir)/scripts/apibuild.py \
+$(APIBUILD_STAMP): $(srcdir)/apibuild.py \
 		$(top_srcdir)/include/libvirt/libvirt.h \
 		$(top_srcdir)/include/libvirt/libvirt-common.h.in \
-		$(top_srcdir)/include/libvirt/libvirt-domain-checkpoint.h \
 		$(top_srcdir)/include/libvirt/libvirt-domain-snapshot.h \
 		$(top_srcdir)/include/libvirt/libvirt-domain.h \
 		$(top_srcdir)/include/libvirt/libvirt-event.h \
@@ -499,7 +332,6 @@ $(APIBUILD_STAMP): $(top_srcdir)/scripts/apibuild.py \
 		$(top_srcdir)/include/libvirt/libvirt-admin.h \
 		$(top_srcdir)/include/libvirt/virterror.h \
 		$(top_srcdir)/src/libvirt.c \
-		$(top_srcdir)/src/libvirt-domain-checkpoint.c \
 		$(top_srcdir)/src/libvirt-domain-snapshot.c \
 		$(top_srcdir)/src/libvirt-domain.c \
 		$(top_srcdir)/src/libvirt-host.c \
@@ -512,10 +344,65 @@ $(APIBUILD_STAMP): $(top_srcdir)/scripts/apibuild.py \
 		$(top_srcdir)/src/libvirt-stream.c \
 		$(top_srcdir)/src/libvirt-lxc.c \
 		$(top_srcdir)/src/libvirt-qemu.c \
-		$(top_srcdir)/src/admin/libvirt-admin.c \
+		$(top_srcdir)/src/libvirt-admin.c \
 		$(top_srcdir)/src/util/virerror.c \
 		$(top_srcdir)/src/util/virevent.c \
-		$(top_srcdir)/src/util/virtypedparam-public.c
-	$(AM_V_GEN)srcdir=$(srcdir) builddir=$(builddir) \
-		$(RUNUTF8) $(PYTHON) $(APIBUILD)
+		$(top_srcdir)/src/util/virtypedparam.c
+	$(AM_V_GEN)srcdir=$(srcdir) builddir=$(builddir) $(PYTHON) $(APIBUILD)
 	touch $@
+
+
+check-local: all
+dist-local: all
+
+clean-local:
+	rm -f *~ *.bak *.hierarchy *.signals *-unused.txt *.html html/*.html
+
+maintainer-clean-local: clean-local
+	rm -rf $(srcdir)/libvirt-api.xml $(srcdir)/libvirt-refs.xml
+	rm -rf $(srcdir)/libvirt-qemu-api.xml $(srcdir)/libvirt-qemu-refs.xml
+	rm -rf $(srcdir)/libvirt-lxc-api.xml $(srcdir)/libvirt-lxc-refs.xml
+	rm -rf $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml
+	rm -rf $(APIBUILD_STAMP)
+
+rebuild: api qemu_api lxc_api admin_api all
+
+install-data-local:
+	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)
+	for f in $(css) $(dot_html) $(gif) $(png); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done
+	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/logos
+	for f in $(logofiles); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/logos; done
+	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/html
+	for h in $(apihtml); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$h $(DESTDIR)$(HTML_DIR)/html; done
+	for p in $(apipng); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$p $(DESTDIR)$(HTML_DIR)/html; done
+	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/internals
+	for f in $(internals_html); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/internals; done
+	$(mkinstalldirs) $(DESTDIR)$(DEVHELP_DIR)
+	for file in $(devhelphtml) $(devhelppng) $(devhelpcss); do \
+	    $(INSTALL) -m 0644 $(srcdir)/$${file} $(DESTDIR)$(DEVHELP_DIR) ; \
+	done
+	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/fonts
+	for f in $(fonts); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/fonts; \
+	done
+
+uninstall-local:
+	for f in $(css) $(dot_html) $(gif) $(png) $(fonts); do \
+	  rm -f $(DESTDIR)$(HTML_DIR)/$$f; \
+	done
+	for f in $(logofiles); do \
+	  rm -f $(DESTDIR)$(HTML_DIR)/$$f; \
+	done
+	for h in $(apihtml); do rm -f $(DESTDIR)$(HTML_DIR)/$$h; done
+	for p in $(apipng); do rm -f $(DESTDIR)$(HTML_DIR)/$$p; done
+	for f in $(internals_html); do \
+	  rm -f $(DESTDIR)$(HTML_DIR)/$$f; \
+	done
+	for f in $(devhelphtml) $(devhelppng) $(devhelpcss); do \
+	  rm -f $(DESTDIR)$(DEVHELP_DIR)/$$(basename $$f); \
+	done

docs/aclpolkit.html.in

@@ -64,7 +64,7 @@
     </p>
 
     <h3><a id="object_connect">virConnectPtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -80,7 +80,7 @@
     </table>
 
     <h3><a id="object_domain">virDomainPtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -104,7 +104,7 @@
     </table>
 
     <h3><a id="object_interface">virInterfacePtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -128,7 +128,7 @@
     </table>
 
     <h3><a id="object_network">virNetworkPtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -152,7 +152,7 @@
     </table>
 
     <h3><a id="object_node_device">virNodeDevicePtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -172,7 +172,7 @@
     </table>
 
     <h3><a id="object_nwfilter">virNWFilterPtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -196,7 +196,7 @@
     </table>
 
     <h3><a id="object_secret">virSecretPtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -232,7 +232,7 @@
     </table>
 
     <h3><a id="object_storage_pool">virStoragePoolPtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -256,7 +256,7 @@
     </table>
 
     <h3><a id="object_storage_vol">virStorageVolPtr</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Attribute</th>
@@ -317,7 +317,7 @@
     </p>
 
     <h3><a id="object_connect_driver">Connection Driver Name</a></h3>
-    <table>
+    <table class="acl">
       <thead>
         <tr>
           <th>Connection Driver</th>
@@ -365,6 +365,10 @@
           <td>openvz</td>
           <td>OPENVZ</td>
         </tr>
+        <tr>
+          <td>phyp</td>
+          <td>PHYP</td>
+        </tr>
         <tr>
           <td>qemu</td>
           <td>QEMU</td>
@@ -389,6 +393,10 @@
           <td>vz</td>
           <td>vz</td>
         </tr>
+        <tr>
+          <td>xenapi</td>
+          <td>XenAPI</td>
+        </tr>
       </tbody>
     </table>
 

docs/api.html.in

@@ -330,7 +330,7 @@
     daemon through the <a href="remote.html">remote</a> driver via an
     <a href="internals/rpc.html">RPC</a>. Some hypervisors do support
     client-side connections and responses, such as Test, OpenVZ, VMware,
-    VirtualBox (vbox), ESX, Hyper-V, Xen, and Virtuozzo.
+    Power VM (phyp), VirtualBox (vbox), ESX, Hyper-V, Xen, and Virtuozzo.
     The libvirtd daemon service is started on the host at system boot
     time and can also be restarted at any time by a properly privileged
     user, such as root. The libvirtd daemon uses the same libvirt API

docs/api_extension.html.in

@@ -89,7 +89,7 @@
       separately.
     </p>
 
-    <h2><a id='publicapi'>Defining the public API</a></h2>
+    <h2><a name='publicapi'>Defining the public API</a></h2>
 
     <p>The first task is to define the public API.  If the new API
       involves an XML extension, you have to enhance the RelaxNG
@@ -119,7 +119,7 @@
       rework it as you go through the process of implementing it.
     </p>
 
-    <h2><a id='internalapi'>Defining the internal API</a></h2>
+    <h2><a name='internalapi'>Defining the internal API</a></h2>
 
     <p>
       Each public API call is associated with a driver, such as a host
@@ -146,7 +146,7 @@
       provide a <code>NULL</code> stub for the new function.
     </p>
 
-    <h2><a id='implpublic'>Implementing the public API</a></h2>
+    <h2><a name='implpublic'>Implementing the public API</a></h2>
 
     <p>
       Implementing the public API is largely a formality in which we wire up
@@ -179,7 +179,7 @@
 
     <p><code>src/libvirt-$MODULE.c</code></p>
 
-    <h2><a id='remoteproto'>Implementing the remote protocol</a></h2>
+    <h2><a name='remoteproto'>Implementing the remote protocol</a></h2>
 
     <p>
       Implementing the remote protocol is essentially a
@@ -187,7 +187,7 @@
       understood by referring to the existing code.
     </p>
 
-    <h3><a id='wireproto'>Defining the wire protocol format</a></h3>
+    <h3><a name='wireproto'>Defining the wire protocol format</a></h3>
 
     <p>
       Defining the wire protocol involves making additions to:
@@ -226,11 +226,11 @@
         src/remote/remote_protocol.h
     </code></p>
 
-    <h3><a id='rpcclient'>Implement the RPC client</a></h3>
+    <h3><a name='rpcclient'>Implement the RPC client</a></h3>
 
     <p>
-      Implementing the RPC client uses the rpcgen generated .h files.
-      The remote method calls go in:
+      Implementing the uses the rpcgen generated .h files.  The remote
+      method calls go in:
     </p>
 
     <p><code>src/remote/remote_driver.c</code></p>
@@ -256,7 +256,7 @@
       The server side dispatchers are implemented in:
     </p>
 
-    <p><code>src/remote/remote_daemon_dispatch.c</code></p>
+    <p><code>src/remote/daemon_dispatch.c</code></p>
 
     <p>Again, this step uses the .h files generated by make rpcgen.</p>
 

docs/apps.html.in

@@ -30,6 +30,26 @@
       <img src="logos/logo-square-powered-256.png" alt="libvirt powered"/>
     </p>
 
+    <h2><a id="clientserver">Client/Server applications</a></h2>
+
+    <dl>
+      <dt><a href="http://archipelproject.org">Archipel</a></dt>
+      <dd>
+        Archipel is a libvirt-based solution to manage and supervise virtual
+        machines.  It uses XMPP for all communication. There is no web
+        service or custom protocol.  You just need at least one XMPP server,
+        like eJabberd, to start playing with it.  This allows Archipel to
+        work completely real time.  You never have to refresh the user
+        interface, you'll be notified as soon as something happens. You can
+        even use your favorite chat clients to command your infrastructure.
+      </dd>
+      <dd>
+        Isn't it great to be able to open a chat conversation with your
+        virtual machine and say things like "How are you today?" or "Hey,
+        please reboot"?
+      </dd>
+    </dl>
+
     <h2><a id="command">Command line tools</a></h2>
 
     <dl>
@@ -99,12 +119,6 @@
         machines. It is a command line tool for developers that makes it very
         fast and easy to deploy and re-deploy an environment of vm's.
       </dd>
-      <dt><a href="https://github.com/virt-lightning/virt-lightning">virt-lightning</a></dt>
-      <dd>
-        Virt-Lightning uses libvirt, cloud-init and libguestfs to allow anyone
-        to quickly start a new VM. Very much like a container CLI, but with a
-        virtual machine.
-      </dd>
     </dl>
 
     <h2><a id="configmgmt">Configuration Management</a></h2>
@@ -128,7 +142,7 @@
     <h2><a id="continuousintegration">Continuous Integration</a></h2>
 
     <dl>
-      <dt><a href="http://docs.buildbot.net/latest/manual/configuration/workers-libvirt.html">BuildBot</a></dt>
+      <dt><a href="https://buildbot.net/buildbot/docs/current/Libvirt.html">BuildBot</a></dt>
       <dd>
         BuildBot is a system to automate the compile/test cycle required
         by most software projects.  CVS commits trigger new builds, run on
@@ -359,6 +373,12 @@
         metrics. It supports pCPU, vCPU, memory, block device, network interface,
         and performance event metrics for each virtual guest.
       </dd>
+      <dt><a href="https://community.zenoss.org/docs/DOC-4687">Zenoss</a></dt>
+      <dd>
+        The Zenoss libvirt Zenpack adds support for monitoring virtualization
+        servers.  It has been tested with KVM, QEMU, VMware ESX, and VMware
+        GSX.
+      </dd>
     </dl>
 
     <h2><a id="provisioning">Provisioning</a></h2>
@@ -463,6 +483,17 @@
       </dd>
     </dl>
 
+    <h2><a id="mobile">Mobile applications</a></h2>
+
+    <dl>
+      <dt><a href="https://market.android.com/details?id=vm.manager">VM Manager</a></dt>
+      <dd>
+        VM Manager is VM (libvirt) manager (over SSH) application. VM Manager
+        is an application for libvirt VM / Domain management over SSH.
+        Please keep in mind that this software is under heavy development.
+      </dd>
+    </dl>
+
     <h2><a id="other">Other</a></h2>
 
     <dl>

docs/auth.html.in

@@ -129,9 +129,11 @@ credentials=defgrp</pre>
       <li><code>libvirt</code> - used for connections to a libvirtd
         server, which is configured with SASL auth</li>
       <li><code>ssh</code> - used for connections to a Phyp server
-        over SSH, but the Phyp driver has been removed</li>
+        over SSH</li>
       <li><code>esx</code> - used for connections to an ESX or
         VirtualCenter server</li>
+      <li><code>xen</code> - used for connections to a Xen Enterprise
+        sever using XenAPI</li>
     </ol>
 
     <p>
@@ -182,29 +184,15 @@ Default policy will still allow any application to connect to the RO socket.
 </p>
     <p>
 The default policy can be overridden by creating a new policy file in the
-<code>/etc/polkit-1/rules.d</code> directory. Information on the options
-available can be found by reading the <code>polkit(8)</code> man page. The
-two libvirt actions are named <code>org.libvirt.unix.manage</code> for full
-management access, and <code>org.libvirt.unix.monitor</code> for read-only
-access.
-</p>
-    <p>
-As an example, creating <code>/etc/polkit-1/rules.d/80-libvirt-manage.rules</code>
-with the following gives the user <code>fred</code> full management access
-when accessing from an active local session:
-    </p>
-<pre>polkit.addRule(function(action, subject) {
-  if (action.id == "org.libvirt.unix.manage" &amp;&amp;
-      subject.local &amp;&amp; subject.active &amp;&amp; subject.user == "fred") {
-      return polkit.Result.YES;
-  }
-});</pre>
-    <p>
-Older versions of PolicyKit used policy files ending with .pkla in the
 local override directory <code>/etc/polkit-1/localauthority/50-local.d/</code>.
-Compatibility with this older format is provided by <a
-href="https://pagure.io/polkit-pkla-compat">polkit-pkla-compat</a>. As an
-example, this gives the user <code>fred</code> full management access:
+Policy files should have a unique name ending with .pkla.  Using reverse DNS
+naming works well. Information on the options available can be found by
+reading the pklocalauthority man page. The two libvirt daemon actions
+available are named <code>org.libvirt.unix.manage</code> for full management
+access, and <code>org.libvirt.unix.monitor</code> for read-only access.
+    </p>
+    <p>
+As an example, this gives the user <code>fred</code> full management access:
     </p>
 <pre>[Allow fred libvirt management permissions]
 Identity=unix-user:fred
@@ -212,6 +200,10 @@ Action=org.libvirt.unix.manage
 ResultAny=yes
 ResultInactive=yes
 ResultActive=yes</pre>
+    <p>
+Further examples of PolicyKit setup can be found on the
+<a href="http://wiki.libvirt.org/page/SSHPolicyKitSetup">wiki page</a>.
+    </p>
     <h2><a id="ACL_server_sasl">SASL pluggable authentication</a></h2>
 
     <p>
@@ -274,7 +266,7 @@ to turn on SASL auth in these listeners.
     </p>
     <p>
 Since the libvirt SASL config file defaults to using GSSAPI (Kerberos), a
-config change is required to enable plain password auth. This is done by
+config change is rquired to enable plain password auth. This is done by
 editting <code>/etc/sasl2/libvirt.conf</code> to set the <code>mech_list</code>
 parameter to <code>scram-sha-1</code>.
     </p>
@@ -317,7 +309,7 @@ in these scenarios - only the plain TCP listener needs encryption
 Some operating systems do not install the SASL kerberos plugin by default. It
 may be necessary to install a sub-package such as <code>cyrus-sasl-gssapi</code>.
 To check whether the Kerberos plugin is installed run the <code>pluginviewer</code>
-program and verify that <code>gssapi</code> is listed, e.g.:
+program and verify that <code>gssapi</code> is listed,eg:
 </p>
     <pre>
 # pluginviewer
@@ -359,7 +351,7 @@ kadmin.local: quit
     <p>
 Any client application wishing to connect to a Kerberos enabled libvirt server
 merely needs to run <code>kinit</code> to gain a user principal. This may well
-be done automatically when a user logs into a desktop session, if PAM is set up
+be done automatically when a user logs into a desktop session, if PAM is setup
 to authenticate against Kerberos.
 </p>
   </body>

docs/cgroups.html.in

@@ -155,17 +155,24 @@ $ROOT
       named <code>$VMNAME.libvirt-{qemu,lxc}</code>. Each consumer is associated
       with exactly one partition, which also have a corresponding cgroup usually
       named <code>$PARTNAME.partition</code>. The exceptions to this naming rule
-      is the top level default partition for virtual machines and containers
-      <code>/machine</code>.
+      are the three top level default partitions, named <code>/system</code> (for
+      system services), <code>/user</code> (for user login sessions) and
+      <code>/machine</code> (for virtual machines and containers). By default
+      every consumer will of course be associated with the <code>/machine</code>
+      partition.
     </p>
 
     <p>
-      Given this, a possible non-systemd cgroups layout involving 3 qemu guests,
+      Given this, a possible systemd cgroups layout involving 3 qemu guests,
       3 lxc containers and 2 custom child slices, would be:
     </p>
 
     <pre>
 $ROOT
+  |
+  +- system
+  |   |
+  |   +- libvirtd.service
   |
   +- machine
       |

docs/compiling.html.in

@@ -9,15 +9,13 @@
     <h2><a id="compiling">Compiling a release tarball</a></h2>
 
     <p>
-      libvirt uses the standard configure/make/install steps and mandates
-      that the build directory is different that the source directory:
+      libvirt uses the standard configure/make/install steps:
     </p>
 
     <pre>
 $ xz -c libvirt-x.x.x.tar.xz | tar xvf -
 $ cd libvirt-x.x.x
-$ mkdir build &amp;&amp; cd build
-$ ../configure</pre>
+$ ./configure</pre>
 
     <p>
       The <i>configure</i> script can be given options to change its default
@@ -30,7 +28,7 @@ $ ../configure</pre>
     </p>
 
     <pre>
-$ ../configure <i>--help</i></pre>
+$ ./configure <i>--help</i></pre>
 
     <p>
       When you have determined which options you want to use (if any),
@@ -51,7 +49,7 @@ $ ../configure <i>--help</i></pre>
     </p>
 
     <pre>
-$ ../configure <i>[possible options]</i>
+$ ./configure <i>[possible options]</i>
 $ make
 $ <b>sudo</b> <i>make install</i></pre>
 

docs/dbus.html.in

@@ -6,14 +6,14 @@
 
     <ul id="toc"></ul>
 
-    <h2><a id="description">Description</a></h2>
+    <h2><a name="description">Description</a></h2>
 
     <p>
       libvirt-dbus wraps libvirt API to provide a high-level object-oriented
       API better suited for dbus-based applications.
     </p>
 
-    <h2><a id="git">GIT source repository</a></h2>
+    <h2><a name="git">GIT source repository</a></h2>
     <p>
       The D-Bus bindings source code is maintained in a
       <a href="https://git-scm.com/">git</a> repository available on
@@ -32,7 +32,7 @@ git clone https://libvirt.org/git/libvirt-dbus.git
 <a href="https://libvirt.org/git/?p=libvirt-dbus.git">https://libvirt.org/git/?p=libvirt-dbus.git</a>
 </pre>
 
-    <h2><a id="usage">Usage</a></h2>
+    <h2><a name="usage">Usage</a></h2>
 
     <p>
       libvirt-dbus exports libvirt API using D-Bus objects with methods and

docs/devhelp/devhelp.xsl

@@ -0,0 +1,131 @@
+<?xml version="1.0"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
+		xmlns="http://www.devhelp.net/book"
+		xmlns:exsl="http://exslt.org/common"
+		xmlns:str="http://exslt.org/strings"
+		extension-element-prefixes="exsl str"
+		exclude-result-prefixes="exsl str">
+  <!-- The stylesheet for the html pages -->
+  <xsl:import href="html.xsl"/>
+
+  <xsl:output method="xml" encoding="UTF-8" indent="yes"/>
+
+  <!-- Build keys for all symbols -->
+  <xsl:key name="symbols" match="/api/symbols/*" use="@name"/>
+
+  <xsl:template match="/">
+    <xsl:document xmlns="http://www.devhelp.net/book" href="libvirt.devhelp"
+                  method="xml" encoding="UTF-8" indent="yes">
+      <xsl:apply-templates/>
+    </xsl:document>
+  </xsl:template>
+
+  <xsl:template match="/api">
+    <book title="{@name} Reference Manual" link="index.html" author="" name="{@name}">
+      <xsl:apply-templates select="files"/>
+      <xsl:apply-templates select="symbols"/>
+    </book>
+    <xsl:call-template name="generate_index"/>
+    <xsl:call-template name="generate_general"/>
+  </xsl:template>
+  <xsl:template match="/api/files">
+    <chapters>
+      <sub name="API" link="general.html">
+        <xsl:apply-templates select="file"/>
+      </sub>
+    </chapters>
+  </xsl:template>
+  <xsl:template match="/api/files/file">
+    <xsl:variable name="module" select="@name"/>
+    <xsl:variable name="prev" select="string(preceding-sibling::file[position()=1]/@name)"/>
+    <xsl:variable name="next" select="string(following-sibling::file[position()=1]/@name)"/>
+    <sub name="{@name}" link="libvirt-{@name}.html"/>
+    <xsl:document xmlns="" href="libvirt-{@name}.html" method="xml" indent="yes" encoding="UTF-8">
+      <html>
+        <head>
+	  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+	  <title><xsl:value-of select="concat(@name, ': ', summary)"/></title>
+	  <meta name="generator" content="Libvirt devhelp stylesheet"/>
+	  <link rel="start" href="index.html" title="libvirt Reference Manual"/>
+	  <link rel="up" href="general.html" title="API"/>
+	  <link rel="stylesheet" href="style.css" type="text/css"/>
+	  <link rel="chapter" href="general.html" title="API"/>
+        </head>
+	<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+
+          <table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+	    <tr valign="middle">
+	      <xsl:if test="$prev != ''">
+		<td><a accesskey="p" href="libvirt-{$prev}.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"/></a></td>
+	      </xsl:if>
+              <td><a accesskey="u" href="general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"/></a></td>
+              <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"/></a></td>
+	      <xsl:if test="$next != ''">
+		<td><a accesskey="n" href="libvirt-{$next}.html"><img src="right.png" width="24" height="24" border="0" alt="Next"/></a></td>
+	      </xsl:if>
+              <th width="100%" align="center">libvirt Reference Manual</th>
+            </tr>
+	  </table>
+	  <h2><span class="refentrytitle"><xsl:value-of select="@name"/></span></h2>
+	  <p><xsl:value-of select="@name"/> - <xsl:value-of select="summary"/></p>
+	  <p><xsl:value-of select="description"/></p>
+	  <xsl:if test="deprecated">
+	    <p> WARNING: this module is deprecated !</p>
+	  </xsl:if>
+	  <div class="refsynopsisdiv">
+	  <h2>Synopsis</h2>
+	  <pre class="synopsis">
+	    <xsl:apply-templates mode="synopsis" select="exports"/>
+	  </pre>
+	  </div>
+	  <div class="refsect1" lang="en">
+	  <h2>Description</h2>
+	  </div>
+	  <div class="refsect1" lang="en">
+	  <h2>Details</h2>
+	  <div class="refsect2" lang="en">
+	    <xsl:apply-templates mode="details" select="/api/symbols/macro[@file=$module]"/>
+	    <xsl:apply-templates mode="details" select="/api/symbols/typedef[@file=$module] | /api/symbols/struct[@file=$module]"/>
+	    <xsl:apply-templates mode="details" select="/api/symbols/functype[@file=$module]"/>
+	    <xsl:apply-templates mode="details" select="/api/symbols/variable[@file=$module]"/>
+	    <xsl:apply-templates mode="details" select="/api/symbols/function[@file=$module]"/>
+	  </div>
+	  </div>
+	</body>
+      </html>
+    </xsl:document>
+  </xsl:template>
+  <xsl:template match="/api/symbols">
+    <functions>
+      <xsl:apply-templates select="macro"/>
+      <xsl:apply-templates select="enum"/>
+      <xsl:apply-templates select="typedef"/>
+      <xsl:apply-templates select="struct"/>
+      <xsl:apply-templates select="functype"/>
+      <xsl:apply-templates select="variable"/>
+      <xsl:apply-templates select="function"/>
+    </functions>
+  </xsl:template>
+  <xsl:template match="/api/symbols/functype">
+    <function name="{@name}" link="libvirt-{@file}.html#{@name}"/>
+  </xsl:template>
+  <xsl:template match="/api/symbols/function">
+    <function name="{@name} ()" link="libvirt-{@file}.html#{@name}"/>
+  </xsl:template>
+  <xsl:template match="/api/symbols/typedef">
+    <function name="{@name}" link="libvirt-{@file}.html#{@name}"/>
+  </xsl:template>
+  <xsl:template match="/api/symbols/enum">
+    <function name="{@name}" link="libvirt-{@file}.html#{@name}"/>
+  </xsl:template>
+  <xsl:template match="/api/symbols/struct">
+    <function name="{@name}" link="libvirt-{@file}.html#{@name}"/>
+  </xsl:template>
+  <xsl:template match="/api/symbols/macro">
+    <function name="{@name}" link="libvirt-{@file}.html#{@name}"/>
+  </xsl:template>
+  <xsl:template match="/api/symbols/variable">
+    <function name="{@name}" link="libvirt-{@file}.html#{@name}"/>
+  </xsl:template>
+
+</xsl:stylesheet>

docs/devhelp/html.xsl

@@ -0,0 +1,577 @@
+<?xml version="1.0"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
+		xmlns:exsl="http://exslt.org/common"
+		xmlns:str="http://exslt.org/strings"
+		extension-element-prefixes="exsl str"
+		exclude-result-prefixes="exsl str">
+  <xsl:output method="xml" encoding="UTF-8" indent="yes"/>
+
+  <!-- This is convoluted but needed to force the current document to
+       be the API one and not the result tree from the tokenize() result,
+       because the keys are only defined on the main document -->
+  <xsl:template mode="dumptoken" match='*'>
+    <xsl:param name="token"/>
+    <xsl:variable name="ref" select="key('symbols', $token)"/>
+    <xsl:choose>
+      <xsl:when test="$ref">
+        <a href="libvirt-{$ref/@file}.html#{$ref/@name}"><xsl:value-of select="$token"/></a>
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:value-of select="$token"/>
+      </xsl:otherwise>
+    </xsl:choose>
+  </xsl:template>
+
+  <!-- dumps a string, making cross-reference links -->
+  <xsl:template name="dumptext">
+    <xsl:param name="text"/>
+    <xsl:variable name="ctxt" select='.'/>
+    <!-- <xsl:value-of select="$text"/> -->
+    <xsl:for-each select="str:tokenize($text, ' &#9;')">
+      <xsl:apply-templates select="$ctxt" mode='dumptoken'>
+        <xsl:with-param name="token" select="string(.)"/>
+      </xsl:apply-templates>
+      <xsl:if test="position() != last()">
+        <xsl:text> </xsl:text>
+      </xsl:if>
+    </xsl:for-each>
+  </xsl:template>
+
+<!--
+
+             The following builds the Synopsis section
+
+-->
+  <xsl:template mode="synopsis" match="function">
+    <xsl:variable name="name" select="string(@name)"/>
+    <xsl:variable name="nlen" select="string-length($name)"/>
+    <xsl:variable name="tlen" select="string-length(return/@type)"/>
+    <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="return/@type"/>
+    </xsl:call-template>
+    <xsl:text>&#9;</xsl:text>
+    <a href="#{@name}"><xsl:value-of select="@name"/></a>
+    <xsl:if test="$blen - 40 &lt; -8">
+      <xsl:text>&#9;</xsl:text>
+    </xsl:if>
+    <xsl:if test="$blen - 40 &lt; 0">
+      <xsl:text>&#9;</xsl:text>
+    </xsl:if>
+    <xsl:text>&#9;(</xsl:text>
+    <xsl:if test="not(arg)">
+      <xsl:text>void</xsl:text>
+    </xsl:if>
+    <xsl:for-each select="arg">
+      <xsl:call-template name="dumptext">
+        <xsl:with-param name="text" select="@type"/>
+      </xsl:call-template>
+      <xsl:text> </xsl:text>
+      <xsl:value-of select="@name"/>
+      <xsl:if test="position() != last()">
+        <xsl:text>, </xsl:text><br/>
+	<xsl:if test="$blen - 40 &gt; 8">
+	  <xsl:text>&#9;</xsl:text>
+	</xsl:if>
+	<xsl:if test="$blen - 40 &gt; 0">
+	  <xsl:text>&#9;</xsl:text>
+	</xsl:if>
+	<xsl:text>&#9;&#9;&#9;&#9;&#9; </xsl:text>
+      </xsl:if>
+    </xsl:for-each>
+    <xsl:text>);</xsl:text>
+    <xsl:text>
+</xsl:text>
+  </xsl:template>
+
+  <xsl:template mode="synopsis" match="functype">
+    <xsl:variable name="name" select="string(@name)"/>
+    <xsl:variable name="nlen" select="string-length($name)"/>
+    <xsl:variable name="tlen" select="string-length(return/@type)"/>
+    <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
+    <xsl:text>typedef </xsl:text>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="return/@type"/>
+    </xsl:call-template>
+    <xsl:text> </xsl:text>
+    <a href="#{@name}"><xsl:value-of select="@name"/></a>
+    <xsl:if test="$blen - 40 &lt; -8">
+      <xsl:text>&#9;</xsl:text>
+    </xsl:if>
+    <xsl:if test="$blen - 40 &lt; 0">
+      <xsl:text>&#9;</xsl:text>
+    </xsl:if>
+    <xsl:text>&#9;(</xsl:text>
+    <xsl:if test="not(arg)">
+      <xsl:text>void</xsl:text>
+    </xsl:if>
+    <xsl:for-each select="arg">
+      <xsl:call-template name="dumptext">
+        <xsl:with-param name="text" select="@type"/>
+      </xsl:call-template>
+      <xsl:text> </xsl:text>
+      <xsl:value-of select="@name"/>
+      <xsl:if test="position() != last()">
+        <xsl:text>, </xsl:text><br/>
+	<xsl:if test="$blen - 40 &gt; 8">
+	  <xsl:text>&#9;</xsl:text>
+	</xsl:if>
+	<xsl:if test="$blen - 40 &gt; 0">
+	  <xsl:text>&#9;</xsl:text>
+	</xsl:if>
+	<xsl:text>&#9;&#9;&#9;&#9;&#9; </xsl:text>
+      </xsl:if>
+    </xsl:for-each>
+    <xsl:text>);</xsl:text>
+    <xsl:text>
+</xsl:text>
+  </xsl:template>
+
+  <xsl:template mode="synopsis" match="exports[@type='function']">
+    <xsl:variable name="def" select="key('symbols',@symbol)"/>
+    <xsl:apply-templates mode="synopsis" select="$def"/>
+  </xsl:template>
+
+  <xsl:template mode="synopsis" match="exports[@type='typedef']">
+    <xsl:text>typedef </xsl:text>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="string(key('symbols',@symbol)/@type)"/>
+    </xsl:call-template>
+    <xsl:text> </xsl:text>
+    <a href="#{@symbol}"><xsl:value-of select="@symbol"/></a>
+    <xsl:text>;
+</xsl:text>
+  </xsl:template>
+
+  <xsl:template mode="synopsis" match="exports[@type='macro']">
+    <xsl:variable name="def" select="key('symbols',@symbol)"/>
+    <xsl:text>#define </xsl:text>
+    <a href="#{@symbol}"><xsl:value-of select="@symbol"/></a>
+    <xsl:if test="$def/arg">
+      <xsl:text>(</xsl:text>
+      <xsl:for-each select="$def/arg">
+        <xsl:value-of select="@name"/>
+	<xsl:if test="position() != last()">
+	  <xsl:text>, </xsl:text>
+	</xsl:if>
+      </xsl:for-each>
+      <xsl:text>)</xsl:text>
+    </xsl:if>
+    <xsl:text>;
+</xsl:text>
+  </xsl:template>
+  <xsl:template mode="synopsis" match="exports[@type='enum']">
+  </xsl:template>
+  <xsl:template mode="synopsis" match="exports[@type='struct']">
+  </xsl:template>
+
+<!--
+
+             The following builds the Details section
+
+-->
+  <xsl:template mode="details" match="struct">
+    <xsl:variable name="name" select="string(@name)"/>
+    <div class="refsect2" lang="en">
+    <h3><a name="{$name}">Structure </a><xsl:value-of select="$name"/></h3>
+    <pre class="programlisting">
+    <xsl:value-of select="@type"/><xsl:text> {
+</xsl:text>
+    <xsl:if test="not(field)">
+      <xsl:text>The content of this structure is not made public by the API.
+</xsl:text>
+    </xsl:if>
+    <xsl:for-each select="field">
+        <xsl:text>    </xsl:text>
+	<xsl:call-template name="dumptext">
+	  <xsl:with-param name="text" select="@type"/>
+	</xsl:call-template>
+	<xsl:text>&#9;</xsl:text>
+	<xsl:value-of select="@name"/>
+	<xsl:if test="@info != ''">
+	  <xsl:text>&#9;: </xsl:text>
+	  <xsl:call-template name="dumptext">
+	    <xsl:with-param name="text" select="substring(@info, 1, 70)"/>
+	  </xsl:call-template>
+	</xsl:if>
+	<xsl:text>
+</xsl:text>
+    </xsl:for-each>
+    <xsl:text>} </xsl:text>
+    <xsl:value-of select="$name"/>
+    <xsl:text>;
+</xsl:text>
+    </pre>
+    <p>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="info"/>
+    </xsl:call-template>
+    </p><xsl:text>
+</xsl:text>
+    </div><hr/>
+  </xsl:template>
+
+  <xsl:template mode="details" match="typedef[@type != 'enum']">
+    <xsl:variable name="name" select="string(@name)"/>
+    <div class="refsect2" lang="en">
+    <h3><a name="{$name}">Typedef </a><xsl:value-of select="$name"/></h3>
+    <pre class="programlisting">
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="string(@type)"/>
+    </xsl:call-template>
+    <xsl:text> </xsl:text>
+    <xsl:value-of select="$name"/>
+    <xsl:text>;
+</xsl:text>
+    </pre>
+    <p>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="info"/>
+    </xsl:call-template>
+    </p><xsl:text>
+</xsl:text>
+    </div><hr/>
+  </xsl:template>
+
+  <xsl:template mode="details" match="variable">
+    <xsl:variable name="name" select="string(@name)"/>
+    <div class="refsect2" lang="en">
+    <h3><a name="{$name}">Variable </a><xsl:value-of select="$name"/></h3>
+    <pre class="programlisting">
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="string(@type)"/>
+    </xsl:call-template>
+    <xsl:text> </xsl:text>
+    <xsl:value-of select="$name"/>
+    <xsl:text>;
+</xsl:text>
+    </pre>
+    <p>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="info"/>
+    </xsl:call-template>
+    </p><xsl:text>
+</xsl:text>
+    </div><hr/>
+  </xsl:template>
+
+  <xsl:template mode="details" match="typedef[@type = 'enum']">
+    <xsl:variable name="name" select="string(@name)"/>
+    <div class="refsect2" lang="en">
+    <h3><a name="{$name}">Enum </a><xsl:value-of select="$name"/></h3>
+    <pre class="programlisting">
+    <xsl:text>enum </xsl:text>
+    <a href="#{$name}"><xsl:value-of select="$name"/></a>
+    <xsl:text> {
+</xsl:text>
+    <xsl:for-each select="/api/symbols/enum[@type=$name]">
+      <xsl:sort select="@value" data-type="number" order="ascending"/>
+      <xsl:text>    </xsl:text>
+      <a name="{@name}"><xsl:value-of select="@name"/></a>
+      <xsl:if test="@value">
+        <xsl:text> = </xsl:text>
+	<xsl:value-of select="@value"/>
+      </xsl:if>
+      <xsl:if test="@info">
+        <xsl:text> /* </xsl:text>
+	<xsl:value-of select="@info"/>
+        <xsl:text> */</xsl:text>
+      </xsl:if>
+      <xsl:text>
+</xsl:text>
+    </xsl:for-each>
+    <xsl:text>};
+</xsl:text>
+    </pre>
+    <p>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="info"/>
+    </xsl:call-template>
+    </p><xsl:text>
+</xsl:text>
+    </div><hr/>
+  </xsl:template>
+
+  <xsl:template mode="details" match="macro">
+    <xsl:variable name="name" select="string(@name)"/>
+    <div class="refsect2" lang="en">
+    <h3><a name="{$name}">Macro </a><xsl:value-of select="$name"/></h3>
+    <pre class="programlisting">
+    <xsl:text>#define </xsl:text>
+    <a href="#{$name}"><xsl:value-of select="$name"/></a>
+    <xsl:if test="arg">
+      <xsl:text>(</xsl:text>
+      <xsl:for-each select="arg">
+        <xsl:value-of select="@name"/>
+	<xsl:if test="position() != last()">
+	  <xsl:text>, </xsl:text>
+	</xsl:if>
+      </xsl:for-each>
+      <xsl:text>)</xsl:text>
+    </xsl:if>
+    <xsl:text>;
+</xsl:text>
+    </pre>
+    <p>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="info"/>
+    </xsl:call-template>
+    </p>
+    <xsl:if test="arg">
+      <div class="variablelist"><table border="0"><col align="left"/><tbody>
+      <xsl:for-each select="arg">
+        <tr>
+          <td><span class="term"><i><tt><xsl:value-of select="@name"/></tt></i>:</span></td>
+	  <td>
+	    <xsl:call-template name="dumptext">
+	      <xsl:with-param name="text" select="@info"/>
+	    </xsl:call-template>
+	  </td>
+        </tr>
+      </xsl:for-each>
+      </tbody></table></div>
+    </xsl:if>
+    <xsl:text>
+</xsl:text>
+    </div><hr/>
+  </xsl:template>
+
+  <xsl:template mode="details" match="function">
+    <xsl:variable name="name" select="string(@name)"/>
+    <xsl:variable name="nlen" select="string-length($name)"/>
+    <xsl:variable name="tlen" select="string-length(return/@type)"/>
+    <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
+    <div class="refsect2" lang="en">
+    <h3><a name="{$name}"></a><xsl:value-of select="$name"/> ()</h3>
+    <pre class="programlisting">
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="return/@type"/>
+    </xsl:call-template>
+    <xsl:text>&#9;</xsl:text>
+    <xsl:value-of select="@name"/>
+    <xsl:if test="$blen - 40 &lt; -8">
+      <xsl:text>&#9;</xsl:text>
+    </xsl:if>
+    <xsl:if test="$blen - 40 &lt; 0">
+      <xsl:text>&#9;</xsl:text>
+    </xsl:if>
+    <xsl:text>&#9;(</xsl:text>
+    <xsl:if test="not(arg)">
+      <xsl:text>void</xsl:text>
+    </xsl:if>
+    <xsl:for-each select="arg">
+      <xsl:call-template name="dumptext">
+        <xsl:with-param name="text" select="@type"/>
+      </xsl:call-template>
+      <xsl:text> </xsl:text>
+      <xsl:value-of select="@name"/>
+      <xsl:if test="position() != last()">
+        <xsl:text>, </xsl:text><br/>
+	<xsl:if test="$blen - 40 &gt; 8">
+	  <xsl:text>&#9;</xsl:text>
+	</xsl:if>
+	<xsl:if test="$blen - 40 &gt; 0">
+	  <xsl:text>&#9;</xsl:text>
+	</xsl:if>
+	<xsl:text>&#9;&#9;&#9;&#9;&#9; </xsl:text>
+      </xsl:if>
+    </xsl:for-each>
+    <xsl:text>)</xsl:text><br/>
+    <xsl:text>
+</xsl:text>
+    </pre>
+    <p>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="info"/>
+    </xsl:call-template>
+    </p><xsl:text>
+</xsl:text>
+    <xsl:if test="arg | return/@info">
+      <div class="variablelist"><table border="0"><col align="left"/><tbody>
+      <xsl:for-each select="arg">
+        <tr>
+          <td><span class="term"><i><tt><xsl:value-of select="@name"/></tt></i>:</span></td>
+	  <td>
+	    <xsl:call-template name="dumptext">
+	      <xsl:with-param name="text" select="@info"/>
+	    </xsl:call-template>
+	  </td>
+        </tr>
+      </xsl:for-each>
+      <xsl:if test="return/@info">
+        <tr>
+          <td><span class="term"><i><tt>Returns</tt></i>:</span></td>
+	  <td>
+	    <xsl:call-template name="dumptext">
+	      <xsl:with-param name="text" select="return/@info"/>
+	    </xsl:call-template>
+	  </td>
+        </tr>
+      </xsl:if>
+      </tbody></table></div>
+    </xsl:if>
+    </div><hr/>
+  </xsl:template>
+
+  <xsl:template mode="details" match="functype">
+    <xsl:variable name="name" select="string(@name)"/>
+    <xsl:variable name="nlen" select="string-length($name)"/>
+    <xsl:variable name="tlen" select="string-length(return/@type)"/>
+    <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
+    <div class="refsect2" lang="en">
+    <h3><a name="{$name}"></a>Function type <xsl:value-of select="$name"/> </h3>
+    <pre class="programlisting">
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="return/@type"/>
+    </xsl:call-template>
+    <xsl:text>&#9;</xsl:text>
+    <xsl:value-of select="@name"/>
+    <xsl:if test="$blen - 40 &lt; -8">
+      <xsl:text>&#9;</xsl:text>
+    </xsl:if>
+    <xsl:if test="$blen - 40 &lt; 0">
+      <xsl:text>&#9;</xsl:text>
+    </xsl:if>
+    <xsl:text>&#9;(</xsl:text>
+    <xsl:if test="not(arg)">
+      <xsl:text>void</xsl:text>
+    </xsl:if>
+    <xsl:for-each select="arg">
+      <xsl:call-template name="dumptext">
+        <xsl:with-param name="text" select="@type"/>
+      </xsl:call-template>
+      <xsl:text> </xsl:text>
+      <xsl:value-of select="@name"/>
+      <xsl:if test="position() != last()">
+        <xsl:text>, </xsl:text><br/>
+	<xsl:if test="$blen - 40 &gt; 8">
+	  <xsl:text>&#9;</xsl:text>
+	</xsl:if>
+	<xsl:if test="$blen - 40 &gt; 0">
+	  <xsl:text>&#9;</xsl:text>
+	</xsl:if>
+	<xsl:text>&#9;&#9;&#9;&#9;&#9; </xsl:text>
+      </xsl:if>
+    </xsl:for-each>
+    <xsl:text>)</xsl:text><br/>
+    <xsl:text>
+</xsl:text>
+    </pre>
+    <p>
+    <xsl:call-template name="dumptext">
+      <xsl:with-param name="text" select="info"/>
+    </xsl:call-template>
+    </p><xsl:text>
+</xsl:text>
+    <xsl:if test="arg | return/@info">
+      <div class="variablelist"><table border="0"><col align="left"/><tbody>
+      <xsl:for-each select="arg">
+        <tr>
+          <td><span class="term"><i><tt><xsl:value-of select="@name"/></tt></i>:</span></td>
+	  <td>
+	    <xsl:call-template name="dumptext">
+	      <xsl:with-param name="text" select="@info"/>
+	    </xsl:call-template>
+	  </td>
+        </tr>
+      </xsl:for-each>
+      <xsl:if test="return/@info">
+        <tr>
+          <td><span class="term"><i><tt>Returns</tt></i>:</span></td>
+	  <td>
+	    <xsl:call-template name="dumptext">
+	      <xsl:with-param name="text" select="return/@info"/>
+	    </xsl:call-template>
+	  </td>
+        </tr>
+      </xsl:if>
+      </tbody></table></div>
+    </xsl:if>
+    </div><hr/>
+  </xsl:template>
+
+<!--
+
+             The following builds the general.html page
+
+-->
+  <xsl:template name="generate_general">
+    <xsl:variable name="next" select="string(/api/files/file[position()=1]/@name)"/>
+    <xsl:document xmlns="" href="general.html" method="xml" indent="yes" encoding="UTF-8">
+      <html>
+        <head>
+	  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+	  <title><xsl:value-of select="concat(@name, ': ', summary)"/></title>
+	  <meta name="generator" content="Libvirt devhelp stylesheet"/>
+	  <link rel="start" href="index.html" title="libvirt Reference Manual"/>
+	  <link rel="up" href="index.html" title="libvirt Reference Manual"/>
+	  <link rel="stylesheet" href="style.css" type="text/css"/>
+	  <link rel="chapter" href="index.html" title="libvirt Reference Manual"/>
+        </head>
+	<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+
+          <table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+	    <tr valign="middle">
+              <td><a accesskey="u" href="index.html"><img src="up.png" width="24" height="24" border="0" alt="Up"/></a></td>
+              <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"/></a></td>
+	      <xsl:if test="$next != ''">
+		<td><a accesskey="n" href="libvirt-{$next}.html"><img src="right.png" width="24" height="24" border="0" alt="Next"/></a></td>
+	      </xsl:if>
+              <th width="100%" align="center">libvirt Reference Manual</th>
+            </tr>
+	  </table>
+	  <h2><span class="refentrytitle">libvirt API Modules</span></h2>
+	  <p>
+	  <xsl:for-each select="/api/files/file">
+	    <a href="libvirt-{@name}.html"><xsl:value-of select="@name"/></a> - <xsl:value-of select="summary"/><br/>
+	  </xsl:for-each>
+	  </p>
+	</body>
+      </html>
+    </xsl:document>
+  </xsl:template>
+
+<!--
+
+             The following builds the index.html page
+
+-->
+  <xsl:template name="generate_index">
+    <xsl:document xmlns="" href="index.html" method="xml" indent="yes" encoding="UTF-8">
+      <html>
+        <head>
+	  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+	  <title>libvirt Reference Manual</title>
+	  <meta name="generator" content="Libvirt devhelp stylesheet"/>
+	  <link rel="stylesheet" href="style.css" type="text/css"/>
+        </head>
+	<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+
+          <table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+	    <tr valign="middle">
+              <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"/></a></td>
+	      <td><a accesskey="n" href="general.html"><img src="right.png" width="24" height="24" border="0" alt="Next"/></a></td>
+              <th width="100%" align="center">libvirt Reference Manual</th>
+            </tr>
+	  </table>
+	  <h2><span class="refentrytitle">libvirt Reference Manual</span></h2>
+<p>Libvir is a C toolkit to interact with the virtualization capabilities of
+recent versions of Linux (and other OSes). It is free software available
+under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
+Lesser General Public License</a>. Virtualization of the Linux Operating
+System means the ability to run multiple instances of Operating Systems
+concurrently on a single hardware system where the basic resources are driven
+by a Linux instance. The library aim at providing long term stable C API
+initially for the <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen
+paravirtualization</a> but should be able to integrate other virtualization
+mechanisms if needed.</p>
+<p> If you get lost searching for some specific API use, try
+<a href="https://libvirt.org/search.php">the online search
+engine</a> hosted on <a href="https://libvirt.org/">libvirt.org</a>
+it indexes the project page, the APIs as well as the mailing-list archives. </p>
+	</body>
+      </html>
+    </xsl:document>
+  </xsl:template>
+
+</xsl:stylesheet>

docs/devhelp/style.css

@@ -0,0 +1,66 @@
+.synopsis, .classsynopsis
+{
+  background: #eeeeee;
+  border: solid 1px #aaaaaa;
+  padding: 0.5em;
+}
+.programlisting
+{
+  background: #eeeeff;
+  border: solid 1px #aaaaff;
+  padding: 0.5em;
+}
+.variablelist
+{
+  padding: 4px;
+  margin-left: 3em;
+}
+.variablelist td:first-child
+{
+  vertical-align: top;
+}
+table.navigation
+{
+  background: #ffeeee;
+  border: solid 1px #ffaaaa;
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+}
+.navigation a
+{
+  color: #770000;
+}
+.navigation a:visited
+{
+  color: #550000;
+}
+.navigation .title
+{
+  font-size: 200%;
+}
+div.refnamediv
+{
+  margin-top: 2em;
+}
+div.gallery-float
+{
+  float: left;
+  padding: 10px;
+}
+div.gallery-float img
+{
+  border-style: none;
+}
+div.gallery-spacer
+{
+  clear: both;
+}
+a
+{
+  text-decoration: none;
+}
+a:hover
+{
+  text-decoration: underline;
+  color: #FF0000;
+}

docs/docs.html.in

@@ -9,9 +9,6 @@
         <dt><a href="apps.html">Applications</a></dt>
         <dd>Applications known to use libvirt</dd>
 
-        <dt><a href="manpages/index.html">Manual pages</a></dt>
-        <dd>Manual pages for libvirt tools / daemons</dd>
-
         <dt><a href="windows.html">Windows</a></dt>
         <dd>Downloads for Windows</dd>
 
@@ -21,9 +18,6 @@
         <dt><a href="remote.html">Remote access</a></dt>
         <dd>Enable remote access over TCP</dd>
 
-        <dt><a href="tlscerts.html">TLS certs</a></dt>
-        <dd>Generate and deploy x509 certificates for TLS</dd>
-
         <dt><a href="auth.html">Authentication</a></dt>
         <dd>Configure authentication for the libvirt daemon</dd>
 
@@ -54,27 +48,11 @@
     <div class="panel">
       <h2>Application development</h2>
       <dl>
-        <dt><a href="html/index.html">API reference</a></dt>
-        <dd>Reference manual for the C public API, split in
-          <a href="html/libvirt-libvirt-common.html">common</a>,
-          <a href="html/libvirt-libvirt-domain.html">domain</a>,
-          <a href="html/libvirt-libvirt-domain-checkpoint.html">domain checkpoint</a>,
-          <a href="html/libvirt-libvirt-domain-snapshot.html">domain snapshot</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>,
-          <a href="html/libvirt-libvirt-interface.html">interface</a>,
-          <a href="html/libvirt-libvirt-network.html">network</a>,
-          <a href="html/libvirt-libvirt-nodedev.html">node device</a>,
-          <a href="html/libvirt-libvirt-nwfilter.html">network filter</a>,
-          <a href="html/libvirt-libvirt-secret.html">secret</a>,
-          <a href="html/libvirt-libvirt-storage.html">storage</a>,
-          <a href="html/libvirt-libvirt-stream.html">stream</a>
-          and
-          <a href="html/index-admin.html">admin</a>,
-          <a href="html/index-qemu.html">QEMU</a>,
-          <a href="html/index-lxc.html">LXC</a> libs
-        </dd>
+        <dt><a href="devguide.html">Development Guide</a></dt>
+        <dd>A guide and reference for developing with libvirt</dd>
+
+        <dt><a href="virshcmdref.html">Virsh Commands</a></dt>
+        <dd>Command reference for virsh</dd>
 
         <dt><a href="bindings.html">Language bindings and API modules</a></dt>
         <dd>Bindings of the libvirt API for
@@ -94,25 +72,43 @@
         <dd>Description of the XML schemas for
           <a href="formatdomain.html">domains</a>,
           <a href="formatnetwork.html">networks</a>,
-          <a href="formatnetworkport.html">network ports</a>,
           <a href="formatnwfilter.html">network filtering</a>,
           <a href="formatstorage.html">storage</a>,
           <a href="formatstorageencryption.html">storage encryption</a>,
           <a href="formatcaps.html">capabilities</a>,
           <a href="formatdomaincaps.html">domain capabilities</a>,
-          <a href="formatstoragecaps.html">storage pool capabilities</a>,
           <a href="formatnode.html">node devices</a>,
           <a href="formatsecret.html">secrets</a>,
-          <a href="formatsnapshot.html">snapshots</a>,
-          <a href="formatcheckpoint.html">checkpoints</a>,
-          <a href="formatbackup.html">backup jobs</a></dd>
+          <a href="formatsnapshot.html">snapshots</a></dd>
 
         <dt><a href="uri.html">URI format</a></dt>
         <dd>The URI formats used for connecting to libvirt</dd>
 
+        <dt><a href="locking.html">Disk locking</a></dt>
+        <dd>Ensuring exclusive guest access to disks with
+          <a href="locking-lockd.html">virtlockd</a> or
+          <a href="locking-sanlock.html">Sanlock</a></dd>
+
         <dt><a href="cgroups.html">CGroups</a></dt>
         <dd>Control groups integration</dd>
 
+        <dt><a href="html/index.html">API reference</a></dt>
+        <dd>Reference manual for the C public API, split in
+          <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-virterror.html">error</a>,
+          <a href="html/libvirt-libvirt-event.html">event</a>,
+          <a href="html/libvirt-libvirt-host.html">host</a>,
+          <a href="html/libvirt-libvirt-interface.html">interface</a>,
+          <a href="html/libvirt-libvirt-network.html">network</a>,
+          <a href="html/libvirt-libvirt-nodedev.html">node device</a>,
+          <a href="html/libvirt-libvirt-nwfilter.html">network filter</a>,
+          <a href="html/libvirt-libvirt-secret.html">secret</a>,
+          <a href="html/libvirt-libvirt-storage.html">storage</a>,
+          <a href="html/libvirt-libvirt-stream.html">stream</a>
+        </dd>
+
         <dt><a href="drivers.html">Drivers</a></dt>
         <dd>Hypervisor specific driver information</dd>
 
@@ -122,8 +118,8 @@
         <dt><a href="hvsupport.html">Driver support</a></dt>
         <dd>matrix of API support per hypervisor per release</dd>
 
-        <dt><a href="kbase.html">Knowledge Base</a></dt>
-        <dd>Task oriented guides to key features</dd>
+        <dt><a href="secureusage.html">Secure usage</a></dt>
+        <dd>Secure usage of the libvirt APIs</dd>
       </dl>
     </div>
 
@@ -133,12 +129,6 @@
         <dt><a href="hacking.html">Contributor guidelines</a></dt>
         <dd>General hacking guidelines for contributors</dd>
 
-        <dt><a href="styleguide.html">Docs style guide</a></dt>
-        <dd>Style guidelines for reStructuredText docs</dd>
-
-        <dt><a href="strategy.html">Project strategy</a></dt>
-        <dd>Sets a vision for future direction &amp; technical choices</dd>
-
         <dt><a href="bugs.html">Bug reports</a></dt>
         <dd>How and where to report bugs and request features</dd>
 
@@ -166,6 +156,9 @@
         <dt><a href="internals/locking.html">Lock managers</a></dt>
         <dd>Use lock managers to protect disk content</dd>
 
+        <dt><a href="internals/oomtesting.html">Out of memory testing</a></dt>
+        <dd>Simulating OOM conditions in the test suite</dd>
+
         <dt><a href="testsuites.html">Functional testing</a></dt>
         <dd>Testing libvirt with <a href="testtck.html">TCK test suite</a> and
          <a href="testapi.html">Libvirt-test-API</a></dd>

docs/downloads.html.in

@@ -27,7 +27,8 @@
         <tr>
           <td>libvirt</td>
           <td>
-            <a href="https://libvirt.org/sources/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/">ftp</a>
+            <a href="https://libvirt.org/sources/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt.git;a=summary">libvirt</a>
@@ -47,7 +48,8 @@
         <tr>
           <td>C#</td>
           <td>
-            <a href="https://libvirt.org/sources/csharp/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/csharp/">ftp</a>
+            <a href="https://libvirt.org/sources/csharp/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-csharp.git;a=summary">libvirt</a>
@@ -61,7 +63,8 @@
         <tr>
           <td>Go</td>
           <td>
-            <a href="https://libvirt.org/sources/go/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/go/">ftp</a>
+            <a href="https://libvirt.org/sources/go/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-go.git;a=summary">libvirt</a>
@@ -77,7 +80,8 @@
         <tr>
           <td>Java</td>
           <td>
-            <a href="https://libvirt.org/sources/java/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/java/">ftp</a>
+            <a href="https://libvirt.org/sources/java/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-java.git;a=summary">libvirt</a>
@@ -91,7 +95,8 @@
         <tr>
           <td>OCaml</td>
           <td>
-            <a href="https://libvirt.org/sources/ocaml/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/ocaml/">ftp</a>
+            <a href="https://libvirt.org/sources/ocaml/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-ocaml.git;a=summary">libvirt</a>
@@ -105,7 +110,7 @@
         <tr>
           <td>Perl (Sys::Virt)</td>
           <td>
-            <a href="https://metacpan.org/release/Sys-Virt/">cpan</a>
+            <a href="http://search.cpan.org/dist/Sys-Virt/">cpan</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-perl.git;a=summary">libvirt</a>
@@ -115,14 +120,15 @@
             <a href="https://github.com/libvirt/libvirt-perl">github</a>
           </td>
           <td>
-            <a href="https://metacpan.org/release/Sys-Virt/">api ref</a>
+            <a href="http://search.cpan.org/dist/Sys-Virt/">api ref</a>
             <a href="https://libvirt.org/git/?p=libvirt-perl.git;a=blob;f=Changes;hb=HEAD">changes</a>
           </td>
         </tr>
         <tr>
           <td>PHP</td>
           <td>
-            <a href="https://libvirt.org/sources/php/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/php/">ftp</a>
+            <a href="https://libvirt.org/sources/php/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-php.git;a=summary">libvirt</a>
@@ -136,7 +142,8 @@
         <tr>
           <td>Python</td>
           <td>
-            <a href="https://libvirt.org/sources/python/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/python/">ftp</a>
+            <a href="https://libvirt.org/sources/python/">https</a>
             <a href="https://pypi.python.org/pypi/libvirt-python">pypi</a>
           </td>
           <td>
@@ -151,7 +158,8 @@
         <tr>
           <td>Ruby</td>
           <td>
-            <a href="https://libvirt.org/sources/ruby/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/ruby/">ftp</a>
+            <a href="https://libvirt.org/sources/ruby/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=ruby-libvirt.git;a=summary">libvirt</a>
@@ -165,7 +173,8 @@
         <tr>
           <td>Rust</td>
           <td>
-            <a href="https://libvirt.org/sources/rust/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/rust/">ftp</a>
+            <a href="https://libvirt.org/sources/rust/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-rust.git;a=summary">libvirt</a>
@@ -182,7 +191,8 @@
         <tr>
           <td>GLib / GConfig / GObject</td>
           <td>
-            <a href="https://libvirt.org/sources/glib/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/glib/">ftp</a>
+            <a href="https://libvirt.org/sources/glib/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-glib.git;a=summary">libvirt</a>
@@ -196,7 +206,8 @@
         <tr>
           <td>Go XML</td>
           <td>
-            <a href="https://libvirt.org/sources/go/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/go/">ftp</a>
+            <a href="https://libvirt.org/sources/go/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-go-xml.git;a=summary">libvirt</a>
@@ -212,7 +223,8 @@
         <tr>
           <td>D-Bus</td>
           <td>
-            <a href="https://libvirt.org/sources/dbus/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/dbus/">ftp</a>
+            <a href="https://libvirt.org/sources/dbus/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-dbus.git;a=summary">libvirt</a>
@@ -226,7 +238,8 @@
         <tr>
           <td>Console Proxy</td>
           <td>
-            <a href="https://libvirt.org/sources/consoleproxy/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/consoleproxy/">ftp</a>
+            <a href="https://libvirt.org/sources/consoleproxy/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-console-proxy.git;a=summary">libvirt</a>
@@ -240,7 +253,8 @@
         <tr>
           <td>CIM provider</td>
           <td>
-            <a href="https://libvirt.org/sources/CIM/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/CIM/">ftp</a>
+            <a href="https://libvirt.org/sources/CIM/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-cim.git;a=summary">libvirt</a>
@@ -254,7 +268,8 @@
         <tr>
           <td>CIM utils</td>
           <td>
-            <a href="https://libvirt.org/sources/CIM/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/CIM/">ftp</a>
+            <a href="https://libvirt.org/sources/CIM/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libcmpiutil.git;a=summary">libvirt</a>
@@ -268,7 +283,8 @@
         <tr>
           <td>SNMP</td>
           <td>
-            <a href="https://libvirt.org/sources/snmp/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/snmp/">ftp</a>
+            <a href="https://libvirt.org/sources/snmp/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-snmp.git;a=summary">libvirt</a>
@@ -282,7 +298,8 @@
         <tr>
           <td>Application Sandbox</td>
           <td>
-            <a href="https://libvirt.org/sources/sandbox/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/sandbox/">ftp</a>
+            <a href="https://libvirt.org/sources/sandbox/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-sandbox.git;a=summary">libvirt</a>
@@ -299,7 +316,8 @@
         <tr>
           <td>TCK</td>
           <td>
-            <a href="https://libvirt.org/sources/tck/">libvirt</a>
+            <a href="ftp://libvirt.org/libvirt/tck/">ftp</a>
+            <a href="https://libvirt.org/sources/tck/">https</a>
           </td>
           <td>
             <a href="https://libvirt.org/git/?p=libvirt-tck.git;a=summary">libvirt</a>
@@ -404,11 +422,14 @@
 
     <p>
       Most modules have releases made available for download on the project
-      site via HTTPS. Some modules are instead made available at alternative
-      locations, for example, the Perl binding is made available only on CPAN.
+      site, via FTP, HTTP or HTTPS. Some modules are instead made available
+      at alternative locations, for example, the Perl binding is made
+      available only on CPAN.
     </p>
 
     <ul>
+      <li><a href="ftp://libvirt.org/libvirt/">libvirt.org FTP server</a></li>
+      <li><a href="https://libvirt.org/sources/">libvirt.org HTTP server</a></li>
       <li><a href="https://libvirt.org/sources/">libvirt.org HTTPS server</a></li>
     </ul>
 

docs/drivers.html.in

@@ -6,7 +6,7 @@
 
     <ul>
       <li><a href="#hypervisor">Hypervisor drivers</a></li>
-      <li><a href="storage.html">Storage drivers</a></li>
+      <li><a href="#storage">Storage drivers</a></li>
       <li><a href="drvnodedev.html">Node device driver</a></li>
     </ul>
 
@@ -34,9 +34,24 @@
       <li><strong><a href="drvvmware.html">VMware Workstation/Player</a></strong></li>
       <li><strong><a href="drvxen.html">Xen</a></strong></li>
       <li><strong><a href="drvhyperv.html">Microsoft Hyper-V</a></strong></li>
+      <li><strong><a href="drvphyp.html">IBM PowerVM (phyp)</a></strong></li>
       <li><strong><a href="drvvirtuozzo.html">Virtuozzo</a></strong></li>
       <li><strong><a href="drvbhyve.html">Bhyve</a></strong> - The BSD Hypervisor</li>
     </ul>
 
+    <h2><a id="storage">Storage drivers</a></h2>
+
+    <ul>
+      <li><strong><a href="storage.html#StorageBackendDir">Directory backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendFS">Local filesystem backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendNetFS">Network filesystem backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendLogical">Logical Volume Manager (LVM) backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendDisk">Disk backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendISCSI">iSCSI backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendSCSI">SCSI backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendMultipath">Multipath backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendRBD">RBD (RADOS Block Device) backend</a></strong></li>
+      <li><strong><a href="storage.html#StorageBackendSheepdog">Sheepdog backend</a></strong></li>
+    </ul>
   </body>
 </html>

docs/drvbhyve.html.in

@@ -462,32 +462,5 @@ Example:</p>
 &lt;/domain&gt;
 </pre>
 
-<h3><a id="bhyvecommand">Pass-through of arbitrary bhyve commands</a></h3>
-
-<p><span class="since">Since 5.1.0</span>, it's possible to pass additional command-line
-arguments to the bhyve process when starting the domain using the
-<code>&lt;bhyve:commandline&gt;</code> element under <code>domain</code>.
-To supply an argument, use the element <code>&lt;bhyve:arg&gt;</code> with
-the attribute <code>value</code> set to additional argument to be added.
-The arg element may be repeated multiple times. To use this XML addition, it is necessary
-to issue an XML namespace request (the special <code>xmlns:<i>name</i></code> attribute)
-that pulls in <code>http://libvirt.org/schemas/domain/bhyve/1.0</code>;
-typically, the namespace is given the name of <code>bhyve</code>.
-</p>
-<p>Example:</p>
-<pre>
-&lt;domain type="bhyve" xmlns:bhyve="http://libvirt.org/schemas/domain/bhyve/1.0"&gt;
-  ...
-  &lt;bhyve:commandline&gt;
-    &lt;bhyve:arg value='-somebhyvearg'/&gt;
-  &lt;/bhyve:commandline&gt;
-&lt;/domain&gt;
-</pre>
-
-<p>Note that these extensions are for testing and development purposes only.
-They are <b>unsupported</b>, using them may result in inconsistent state,
-and upgrading either bhyve or libvirtd maybe break behavior of a domain that
-was relying on a specific commands pass-through.</p>
-
   </body>
 </html>

docs/drvesx.html.in

@@ -337,9 +337,7 @@ error: invalid argument in libvirt was built without the 'esx' driver
             Memory size has to be a multiple of 4096
         </li>
         <li>
-            Number of virtual CPU has to be 1 or a multiple of 2.
-            <span class="since">Since 4.10.0</span> any number of vCPUs is
-            supported.
+            Number of virtual CPU has to be 1 or a multiple of 2
         </li>
         <li>
             Valid MAC address prefixes are <code>00:0c:29</code> and

docs/drvphyp.html.in

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body>
+    <h1>IBM PowerVM hypervisor driver (phyp)</h1>
+    <ul id="toc"></ul>
+    <p>
+        The IBM PowerVM driver can manage both HMC and IVM PowerVM
+        guests.  VIOS connections are tunneled through HMC.
+    </p>
+
+
+    <h2><a id="project">Project Links</a></h2>
+    <ul>
+      <li>
+        The <a href="http://www-03.ibm.com/systems/power/software/virtualization/index.html">IBM
+        PowerVM</a> hypervisor
+      </li>
+    </ul>
+
+
+    <h2><a id="uri">Connections to the PowerVM driver</a></h2>
+    <p>
+        Some example remote connection URIs for the driver are:
+    </p>
+<pre>
+phyp://user@hmc/system (HMC connection)
+phyp://user@ivm/system (IVM connection)
+</pre>
+    <p>
+        <strong>Note</strong>: In contrast to other drivers, the
+        PowerVM (or phyp) driver is a client-side-only driver,
+        internally using ssh to connect to the specified hmc or ivm
+        server. Therefore, the <a href="remote.html">remote transport
+        mechanism</a> provided by the remote driver and libvirtd will
+        not work, and you cannot use URIs like
+        <code>phyp+ssh://example.com</code>.
+    </p>
+
+
+    <h3><a id="uriformat">URI Format</a></h3>
+    <p>
+        URIs have this general form (<code>[...]</code> marks an
+        optional part, <code>{...|...}</code> marks a mandatory choice).
+    </p>
+<pre>
+phyp://[username@]{hmc|ivm}/managed_system
+</pre>
+
+</body></html>

docs/drvqemu.html.in

@@ -38,7 +38,7 @@
       <li>
         <strong>KVM hypervisor</strong>: The driver will probe <code>/usr/bin</code>
         for the presence of <code>qemu-kvm</code> and <code>/dev/kvm</code> device
-        node. If both are found, then KVM fully virtualized, hardware accelerated
+        node. If both are found, then KVM fullyvirtualized, hardware accelerated
         guests will be available.
       </li>
     </ul>
@@ -187,29 +187,41 @@ chmod o+x /path/to/directory
       </li>
     </ul>
 
-    <p>
-      The libvirt maintainers <strong>strongly recommend against</strong>
-      running QEMU as the root user/group. This should not be required
-      in most supported usage scenarios, as libvirt will generally do the
-      right thing to grant QEMU access to files it is permitted to
-      use when it is running non-root.
-    </p>
-
     <h3><a id="securitycap">Linux process capabilities</a></h3>
 
     <p>
-      In versions of libvirt prior to 6.0.0, even if QEMU was configured
-      to run as the root user / group, libvirt would strip all process
-      capabilities. This meant that QEMU could only read/write files
-      owned by root, or with open permissions. In reality, stripping
-      capabilities did not have any security benefit, as it was trivial
-      to get commands to run in another context with full capabilities,
-      for example, by creating a cronjob.
+      The libvirt QEMU driver has a build time option allowing it to use
+      the <a href="http://people.redhat.com/sgrubb/libcap-ng/index.html">libcap-ng</a>
+      library to manage process capabilities. If this build option is
+      enabled, then the QEMU driver will use this to ensure that all
+      process capabilities are dropped before executing a QEMU virtual
+      machine. Process capabilities are what gives the 'root' account
+      its high power, in particular the CAP_DAC_OVERRIDE capability
+      is what allows a process running as 'root' to access files owned
+      by any user.
     </p>
+
     <p>
-      Thus since 6.0.0, if QEMU is running as root, it will keep all
-      process capabilities. Behaviour when QEMU is running non-root
-      is unchanged, it still has no capabilities.
+      If the QEMU driver is configured to run virtual machines as non-root,
+      then they will already lose all their process capabilities at time
+      of startup. The Linux capability feature is thus aimed primarily at
+      the scenario where the QEMU processes are running as root. In this
+      case, before launching a QEMU virtual machine, libvirtd will use
+      libcap-ng APIs to drop all process capabilities. It is important
+      for administrators to note that this implies the QEMU process will
+      <strong>only</strong> be able to access files owned by root, and
+      not files owned by any other user.
+    </p>
+
+    <p>
+      Thus, if a vendor / distributor has configured their libvirt package
+      to run as 'qemu' by default, a number of changes will be required
+      before an administrator can change a host to run guests as root.
+      In particular it will be necessary to change ownership on the
+      directories <code>/var/run/libvirt/qemu/</code>,
+      <code>/var/lib/libvirt/qemu/</code> and
+      <code>/var/cache/libvirt/qemu/</code> back to root, in addition
+      to changing the <code>/etc/libvirt/qemu.conf</code> settings.
     </p>
 
     <h3><a id="securityselinux">SELinux basic confinement</a></h3>
@@ -364,7 +376,7 @@ chmod o+x /path/to/directory
     <h3><a id="securityacl">Cgroups device ACLs</a></h3>
 
     <p>
-      Linux kernels have a capability known as "cgroups" which is used
+      Recent Linux kernels have a capability known as "cgroups" which is used
       for resource management. It is implemented via a number of "controllers",
       each controller covering a specific task/functional area. One of the
       available controllers is the "devices" controller, which is able to
@@ -383,8 +395,9 @@ chmod o+x /path/to/directory
 <pre>
 /dev/null, /dev/full, /dev/zero,
 /dev/random, /dev/urandom,
-/dev/ptmx, /dev/kvm,
-/dev/rtc, /dev/hpet
+/dev/ptmx, /dev/kvm, /dev/kqemu,
+/dev/rtc, /dev/hpet, /dev/net/tun,
+/dev/sev
 </pre>
 
     <p>
@@ -414,10 +427,6 @@ mount -t cgroup none /dev/cgroup -o devices
 
     <h3><a id="xmlimport">Converting from QEMU args to domain XML</a></h3>
 
-    <p>
-      <b>Note:</b> this operation is <span class="removed"> deleted as of
-        5.5.0</span> and will return an error.
-    </p>
     <p>
       The <code>virsh domxml-from-native</code> provides a way to
       convert an existing set of QEMU args into a guest description
@@ -431,17 +440,82 @@ mount -t cgroup none /dev/cgroup -o devices
       examples) or by manually crafting XML to pass to virsh.
     </p>
 
+    <pre>$ cat &gt; demo.args &lt;&lt;EOF
+LC_ALL=C PATH=/bin HOME=/home/test USER=test \
+LOGNAME=test /usr/bin/qemu -S -M pc -m 214 -smp 1 \
+-nographic -monitor pty -no-acpi -boot c -hda \
+/dev/HostVG/QEMUGuest1 -net none -serial none \
+-parallel none -usb
+EOF
+
+$ virsh domxml-from-native qemu-argv demo.args
+&lt;domain type='qemu'&gt;
+  &lt;uuid&gt;00000000-0000-0000-0000-000000000000&lt;/uuid&gt;
+  &lt;memory&gt;219136&lt;/memory&gt;
+  &lt;currentMemory&gt;219136&lt;/currentMemory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type arch='i686' machine='pc'&gt;hvm&lt;/type&gt;
+    &lt;boot dev='hd'/&gt;
+  &lt;/os&gt;
+  &lt;clock offset='utc'/&gt;
+  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+  &lt;on_crash&gt;destroy&lt;/on_crash&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/bin/qemu&lt;/emulator&gt;
+    &lt;disk type='block' device='disk'&gt;
+      &lt;source dev='/dev/HostVG/QEMUGuest1'/&gt;
+      &lt;target dev='hda' bus='ide'/&gt;
+    &lt;/disk&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;
+</pre>
+
+    <p>NB, don't include the literal \ in the args, put everything on one line</p>
+
     <h3><a id="xmlexport">Converting from domain XML to QEMU args</a></h3>
 
     <p>
       The <code>virsh domxml-to-native</code> provides a way to convert a
       guest description using libvirt Domain XML, into a set of QEMU args
-      that can be run manually. Note that currently the command line formatted
-      by libvirt is no longer suited for manually running qemu as the
-      configuration expects various resources and open file descriptors passed
-      to the process which are usually prepared by libvirtd.
+      that can be run manually.
     </p>
 
+    <pre>$ cat &gt; demo.xml &lt;&lt;EOF
+&lt;domain type='qemu'&gt;
+  &lt;name&gt;QEMUGuest1&lt;/name&gt;
+  &lt;uuid&gt;c7a5fdbd-edaf-9455-926a-d65c16db1809&lt;/uuid&gt;
+  &lt;memory&gt;219200&lt;/memory&gt;
+  &lt;currentMemory&gt;219200&lt;/currentMemory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type arch='i686' machine='pc'&gt;hvm&lt;/type&gt;
+    &lt;boot dev='hd'/&gt;
+  &lt;/os&gt;
+  &lt;clock offset='utc'/&gt;
+  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+  &lt;on_crash&gt;destroy&lt;/on_crash&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/bin/qemu&lt;/emulator&gt;
+    &lt;disk type='block' device='disk'&gt;
+      &lt;source dev='/dev/HostVG/QEMUGuest1'/&gt;
+      &lt;target dev='hda' bus='ide'/&gt;
+    &lt;/disk&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;
+EOF
+
+$ virsh domxml-to-native qemu-argv demo.xml
+  LC_ALL=C PATH=/usr/bin:/bin HOME=/home/test \
+  USER=test LOGNAME=test /usr/bin/qemu -S -M pc \
+  -no-kqemu -m 214 -smp 1 -name QEMUGuest1 -nographic \
+  -monitor pty -no-acpi -boot c -drive \
+  file=/dev/HostVG/QEMUGuest1,if=ide,index=0 -net none \
+  -serial none -parallel none -usb
+</pre>
+
     <h2><a id="qemucommand">Pass-through of arbitrary qemu
     commands</a></h2>
 
@@ -466,8 +540,7 @@ mount -t cgroup none /dev/cgroup -o devices
       qemu guest (<span class="since">Since 0.8.3</span>),
       and <code>virDomainQemuAttach</code>, for registering a qemu
       domain that was manually started so that it can then be managed
-      by libvirtd (<span class="since">Since 0.9.4</span>,
-      <span class="removed">removed as of 5.5.0</span>).
+      by libvirtd (<span class="since">Since 0.9.4</span>).
     </p>
     <p>Additionally, the following XML additions allow fine-tuning of
       the command line given to qemu when starting a domain
@@ -508,36 +581,6 @@ mount -t cgroup none /dev/cgroup -o devices
     &lt;qemu:env name='QEMU_ENV' value='VAL'/&gt;
   &lt;/qemu:commandline&gt;
 &lt;/domain&gt;
-</pre>
-
-    <h2><a id="xmlnsfeatures">QEMU feature configuration for testing</a></h2>
-
-      <p>
-        In some cases e.g. when developing a new feature or for testing it may
-        be required to control a given qemu feature (or qemu capability) to test
-        it before it's complete or disable it for debugging purposes.
-        <span class="since">Since 5.5.0</span> it's possible to use the same
-        special qemu namespace as above
-        (<code>http://libvirt.org/schemas/domain/qemu/1.0</code>) and use
-        <code>&lt;qemu:capabilities&gt;</code> element to add
-        (<code>&lt;qemu:add capability="capname"/&gt;</code>) or remove
-        (<code>&lt;qemu:del capability="capname"/&gt;</code>) capability bits.
-        The naming of the feature bits is the same libvirt uses in the status
-        XML. Note that this feature is meant for experiments only and should
-        _not_ be used in production.
-      </p>
-
-      <p>Example:</p><pre>
-&lt;domain type='qemu' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'&gt;
-  &lt;name&gt;testvm&lt;/name&gt;
-
-   [...]
-
-  &lt;qemu:capabilities&gt;
-    &lt;qemu:add capability='blockdev'/&gt;
-    &lt;qemu:del capability='drive'/&gt;
-  &lt;/qemu:capabilities&gt;
-&lt;/domain&gt;
 </pre>
 
     <h2><a id="xmlconfig">Example domain XML config</a></h2>

docs/drvxen.html.in

@@ -58,7 +58,8 @@ xen+ssh://root@example.com/system (remote access, SSH tunnelled)
       original Xen virtual machine config format used by the legacy
       xm/xend toolstack. The second, known as <code>xen-sxpr</code>,
       is also one of the original formats that was used by xend's
-      legacy HTTP RPC service (<span class='removed'>removed in 5.6.0</span>)
+      legacy HTTP RPC service. For compatibility, import and export
+      of these legacy formats is supported by the libxl driver.
     </p>
 
     <p>

docs/firewall.html.in

@@ -129,44 +129,6 @@ MASQUERADE all  --  *      *       192.168.122.0/24    !192.168.122.0/24</pre>
       </li>
     </ul>
 
-    <h3><a id="fw-firewalld-and-virtual-network-driver">firewalld and the virtual network driver</a>
-    </h3>
-    <p>
-      If <a href="https://firewalld.org">firewalld</a> is active on
-      the host, libvirt will attempt to place the bridge interface of
-      a libvirt virtual network into the firewalld zone named
-      "libvirt" (thus making all guest->host traffic on that network
-      subject to the rules of the "libvirt" zone). This is done
-      because, if firewalld is using its nftables backend (available
-      since firewalld 0.6.0) the default firewalld zone (which would
-      be used if libvirt didn't explicitly set the zone) prevents
-      forwarding traffic from guests through the bridge, as well as
-      preventing DHCP, DNS, and most other traffic from guests to
-      host. The zone named "libvirt" is installed into the firewalld
-      configuration by libvirt (not by firewalld), and allows
-      forwarded traffic through the bridge as well as DHCP, DNS, TFTP,
-      and SSH traffic to the host - depending on firewalld's backend
-      this will be implemented via either iptables or nftables
-      rules. libvirt's own rules outlined above will *always* be
-      iptables rules regardless of which backend is in use by
-      firewalld.
-    </p>
-    <p>
-      NB: It is possible to manually set the firewalld zone for a
-      network's interface with the "zone" attribute of the network's
-      "bridge" element.
-    </p>
-    <p>
-      NB: Prior to libvirt 5.1.0, the firewalld "libvirt" zone did not
-      exist, and prior to firewalld 0.7.0 a feature crucial to making
-      the "libvirt" zone operate properly (rich rule priority
-      settings) was not implemented in firewalld. In cases where one
-      or the other of the two packages is missing the necessary
-      functionality, it's still possible to have functional guest
-      networking by setting the firewalld backend to "iptables" (in
-      firewalld prior to 0.6.0, this was the only backend available).
-    </p>
-
     <h3><a id="fw-network-filter-driver">The network filter driver</a>
     </h3>
     <p>This driver provides a fully configurable network filtering capability

docs/format.html.in

@@ -17,17 +17,13 @@
       <li><a href="formatdomain.html">Domains</a></li>
       <li><a href="formatnetwork.html">Networks</a></li>
       <li><a href="formatnwfilter.html">Network filtering</a></li>
-      <li><a href="formatnetworkport.html">Network ports</a></li>
       <li><a href="formatstorage.html">Storage</a></li>
       <li><a href="formatstorageencryption.html">Storage encryption</a></li>
       <li><a href="formatcaps.html">Capabilities</a></li>
       <li><a href="formatdomaincaps.html">Domain capabilities</a></li>
-      <li><a href="formatstoragecaps.html">Storage Pool capabilities</a></li>
       <li><a href="formatnode.html">Node devices</a></li>
       <li><a href="formatsecret.html">Secrets</a></li>
       <li><a href="formatsnapshot.html">Snapshots</a></li>
-      <li><a href="formatcheckpoint.html">Checkpoints</a></li>
-      <li><a href="formatbackup.html">Backup jobs</a></li>
     </ul>
 
     <h2>Command line validation</h2>

docs/formatbackup.html.in

@@ -1,175 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body>
-    <h1>Backup XML format</h1>
-
-    <ul id="toc"></ul>
-
-    <h2><a id="BackupAttributes">Backup XML</a></h2>
-
-    <p>
-      Creating a backup, whether full or incremental, is done
-      via <code>virDomainBackupBegin()</code>, which takes an XML
-      description of the actions to perform, as well as an optional
-      second XML document <a href="formatcheckpoint.html">describing a
-      checkpoint</a> to create at the same point in time. See
-      also <a href="domainstatecapture.html">a comparison</a> between
-      the various state capture APIs.
-    </p>
-    <p>
-      There are two general modes for backups: a push mode (where the
-      hypervisor writes out the data to the destination file, which
-      may be local or remote), and a pull mode (where the hypervisor
-      creates an NBD server that a third-party client can then read as
-      needed, and which requires the use of temporary storage,
-      typically local, until the backup is complete).
-    </p>
-    <p>
-      The instructions for beginning a backup job are provided as
-      attributes and elements of the
-      top-level <code>domainbackup</code> element. This element
-      includes an optional attribute <code>mode</code> which can be
-      either "push" or "pull" (default
-      push). <code>virDomainBackupGetXMLDesc()</code> can be used to
-      see the actual values selected for elements omitted during
-      creation (for example, learning which port the NBD server is
-      using in the pull model or what file names libvirt generated
-      when none were supplied). The following child elements and attributes
-      are supported:
-    </p>
-    <dl>
-      <dt><code>incremental</code></dt>
-      <dd>An optional element giving the name of an existing
-        checkpoint of the domain, which will be used to make this
-        backup an incremental one. In the push model, only changes
-        since the named checkpoint are written to the destination. In
-        the pull model, the NBD server uses the
-        NBD_OPT_SET_META_CONTEXT extension to advertise to the client
-        which portions of the export contain changes since the named
-        checkpoint. If omitted, a full backup is performed.
-      </dd>
-      <dt><code>server</code></dt>
-      <dd>Present only for a pull mode backup. Contains the same
-        attributes as
-        the <a href="formatdomain.html#elementsDisks"><code>protocol</code>
-        element of a disk</a> attached via NBD in the domain (such as
-        transport, socket, name, port, or tls), necessary to set up an
-        NBD server that exposes the content of each disk at the time
-        the backup is started.
-      </dd>
-      <dt><code>disks</code></dt>
-      <dd>An optional listing of instructions for disks participating
-        in the backup (if omitted, all disks participate and libvirt
-        attempts to generate filenames by appending the current
-        timestamp as a suffix). If the entire element was omitted on
-        input, then all disks participate in the backup, otherwise,
-        only the disks explicitly listed which do not also
-        use <code>backup='no'</code> will participate. On output, this
-        is the state of each of the domain's disk in relation to the
-        backup operation.
-        <dl>
-          <dt><code>disk</code></dt>
-          <dd>This sub-element describes the backup properties of a
-            specific disk, with the following attributes and child
-            elements:
-            <dl>
-              <dt><code>name</code></dt>
-              <dd>A mandatory attribute which must match
-                the <code>&lt;target dev='name'/&gt;</code>
-                of one of
-                the <a href="formatdomain.html#elementsDisks">disk
-                devices</a> specified for the domain at the time of
-                the checkpoint.</dd>
-              <dt><code>backup</code></dt>
-              <dd>Setting this attribute to <code>yes</code>(default) specifies
-                that the disk should take part in the backup and using
-                <code>no</code> excludes the disk from the backup.</dd>
-              <dt><code>type</code></dt>
-              <dd>A mandatory attribute to describe the type of the
-                disk, except when <code>backup='no'</code> is
-                used. Valid values include <code>file</code>,
-                <code>block</code>, or <code>network</code>.
-                Similar to a disk declaration for a domain, the choice of type
-                controls what additional sub-elements are needed to describe
-                the destination (such as <code>protocol</code> for a
-                network destination).</dd>
-              <dt><code>target</code></dt>
-              <dd>Valid only for push mode backups, this is the
-                primary sub-element that describes the file name of
-                the backup destination, similar to
-                the <code>source</code> sub-element of a domain
-                disk. An optional sub-element <code>driver</code> can
-                also be used, with an attribute <code>type</code> to
-                specify a destination format different from
-                qcow2. </dd>
-              <dt><code>scratch</code></dt>
-              <dd>Valid only for pull mode backups, this is the
-                primary sub-element that describes the file name of
-                the local scratch file to be used in facilitating the
-                backup, and is similar to the <code>source</code>
-                sub-element of a domain disk. Currently only <code>file</code>
-                and <code>block</code> scratch storage is supported. The
-                <code>file</code> scratch file is created and deleted by
-                libvirt in the given location. A <code>block</code> scratch
-                device must exist prior to starting the backup and is formatted.
-                The block device must have enough space for the corresponding
-                disk data including format overhead.
-
-                If <code>VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL</code> flag is
-                used the file for a scratch of <code>file</code> type must
-                exist with the correct format and size to hold the copy and is
-                used without modification. The file is not deleted after the
-                backup but the contents of the file don't make sense outside
-                of the backup. The same applies for the block device which
-                must be formatted appropriately.</dd>
-            </dl>
-          </dd>
-        </dl>
-      </dd>
-    </dl>
-
-    <h2><a id="example">Examples</a></h2>
-
-    <p>Use <code>virDomainBackupBegin()</code> to perform a full
-      backup using push mode. The example lets libvirt pick the
-      destination and format for 'vda', fully specifies that we want a
-      raw backup of 'vdb', and omits 'vdc' from the operation.
-    </p>
-    <pre>
-&lt;domainbackup&gt;
-  &lt;disks&gt;
-    &lt;disk name='vda' backup='yes'/&gt;
-    &lt;disk name='vdb' type='file'&gt;
-      &lt;target file='/path/to/vdb.backup'/&gt;
-      &lt;driver type='raw'/&gt;
-    &lt;/disk&gt;
-    &lt;disk name='vdc' backup='no'/&gt;
-  &lt;/disks&gt;
-&lt;/domainbackup&gt;
-    </pre>
-
-    <p>If the previous full backup also passed a parameter describing
-      <a href="formatcheckpoint.html">checkpoint XML</a> that resulted
-      in a checkpoint named <code>1525889631</code>, we can make
-      another call to <code>virDomainBackupBegin()</code> to perform
-      an incremental backup of just the data changed since that
-      checkpoint, this time using the following XML to start a pull
-      model export of the 'vda' and 'vdb' disks, where a third-party
-      NBD client connecting to '/path/to/server' completes the backup
-      (omitting 'vdc' from the explicit list has the same effect as
-      the backup='no' from the previous example):
-    </p>
-    <pre>
-&lt;domainbackup mode="pull"&gt;
-  &lt;incremental&gt;1525889631&lt;/incremental&gt;
-  &lt;server transport="unix" socket="/path/to/server"/&gt;
-  &lt;disks&gt;
-    &lt;disk name='vda' backup='yes' type='file'&gt;
-      &lt;scratch file='/path/to/file1.scratch'/&gt;
-    &lt;/disk&gt;
-  &lt;/disks&gt;
-&lt;/domainbackup&gt;
-    </pre>
-  </body>
-</html>

docs/formatcheckpoint.html.in

@@ -1,198 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body>
-    <h1>Checkpoint XML format</h1>
-
-    <ul id="toc"></ul>
-
-    <h2><a id="CheckpointAttributes">Checkpoint XML</a></h2>
-
-    <p>
-      One method of capturing domain disk backups is via the use of
-      incremental backups. Right now, incremental backups are only
-      supported for the QEMU hypervisor when using qcow2 disks at the
-      active layer; if other disk formats are in use, capturing disk
-      backups requires different libvirt APIs
-      (see <a href="kbase/domainstatecapture.html">domain state
-      capture</a> for a comparison between APIs).
-    </p>
-    <p>
-      Libvirt is able to facilitate incremental backups by tracking
-      disk checkpoints, which are points in time against which it is
-      easy to compute which portion of the disk has changed. Given a
-      full backup (a backup created from the creation of the disk to a
-      given point in time), coupled with the creation of a disk
-      checkpoint at that time, and an incremental backup (a backup
-      created from just the dirty portion of the disk between the
-      first checkpoint and the second backup operation), it is
-      possible to do an offline reconstruction of the state of the
-      disk at the time of the second backup without having to copy as
-      much data as a second full backup would require. Most disk
-      checkpoints are created in conjunction with a backup
-      via <code>virDomainBackupBegin()</code>, although a future API
-      addition of <code>virDomainSnapshotCreateXML2()</code> will also
-      make this possible when creating external snapshots; however,
-      libvirt also exposes enough support to create disk checkpoints
-      independently from a backup operation
-      via <code>virDomainCheckpointCreateXML()</code> <span class="since">since
-      5.6.0</span>.  Likewise, the creation of checkpoints when
-      external snapshots exist is currently forbidden, although future
-      work will make it possible to integrate these two concepts.
-    </p>
-    <p>
-      Attributes of libvirt checkpoints are stored as child elements
-      of the <code>domaincheckpoint</code> element. At checkpoint
-      creation time, normally only
-      the <code>name</code>, <code>description</code>,
-      and <code>disks</code> elements are settable. The rest of the
-      fields are ignored on creation and will be filled in by libvirt
-      in for informational purposes
-      by <code>virDomainCheckpointGetXMLDesc()</code>. However, when
-      redefining a checkpoint, with
-      the <code>VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE</code> flag
-      of <code>virDomainCheckpointCreateXML()</code>, all of the XML
-      fields described here are relevant on input, even the fields
-      that are normally described as readonly for output.
-    </p>
-    <p>
-      The top-level <code>domaincheckpoint</code> element may contain
-      the following elements:
-    </p>
-    <dl>
-      <dt><code>name</code></dt>
-      <dd>The optional name for this checkpoint. If the name is
-        omitted, libvirt will create a name based on the time of the
-        creation.
-      </dd>
-      <dt><code>description</code></dt>
-      <dd>An optional human-readable description of the checkpoint.
-        If the description is omitted when initially creating the
-        checkpoint, then this field will be empty.
-      </dd>
-      <dt><code>disks</code></dt>
-      <dd>On input, this is an optional listing of specific
-        instructions for disk checkpoints; it is needed when making a
-        checkpoint on only a subset of the disks associated with a
-        domain. In particular, since QEMU checkpoints require qcow2
-        disks, this element may be needed on input for excluding guest
-        disks that are not in qcow2 format. If the entire element was
-        omitted on input, then all disks participate in the
-        checkpoint, otherwise, only the disks explicitly listed which
-        do not also use <code>checkpoint='no'</code> will
-        participate. On output, this is the checkpoint state of each
-        of the domain's disks.
-        <dl>
-          <dt><code>disk</code></dt>
-          <dd>This sub-element describes the checkpoint properties of
-            a specific disk with the following attributes:
-            <dl>
-              <dt><code>name</code></dt>
-              <dd>A mandatory attribute which must match either
-                the <code>&lt;target dev='name'/&gt;</code> or an
-                unambiguous <code>&lt;source file='name'/&gt;</code>
-                of one of
-                the <a href="formatdomain.html#elementsDisks">disk
-                devices</a> specified for the domain at the time of
-                the checkpoint.</dd>
-              <dt><code>checkpoint</code></dt>
-              <dd>An optional attribute; possible values
-                are <code>no</code> when the disk does not participate
-                in this checkpoint; or <code>bitmap</code> if the disk
-                will track all changes since the creation of this
-                checkpoint via a bitmap.</dd>
-              <dt><code>bitmap</code></dt>
-              <dd>The attribute <code>bitmap</code> is only valid
-                if <code>checkpoint='bitmap'</code>; it describes the
-                name of the tracking bitmap (defaulting to the
-                checkpoint name).</dd>
-              <dt><code>size</code></dt>
-              <dd>The attribute <code>size</code> is ignored on input;
-                on output, it is only present if
-                the <code>VIR_DOMAIN_CHECKPOINT_XML_SIZE</code> flag
-                was used to perform a dynamic query of the estimated
-                size in bytes of the changes made since the checkpoint
-                was created.</dd>
-            </dl>
-          </dd>
-        </dl>
-      </dd>
-      <dt><code>creationTime</code></dt>
-      <dd>A readonly representation of the time this checkpoint was
-        created. The time is specified in seconds since the Epoch,
-        UTC (i.e. Unix time).
-      </dd>
-      <dt><code>parent</code></dt>
-      <dd>Readonly, present if this checkpoint has a parent. The
-        parent name is given by the sub-element <code>name</code>. The
-        parent relationship allows tracking a list of related checkpoints.
-      </dd>
-      <dt><code>domain</code></dt>
-      <dd>A readonly representation of the
-        inactive <a href="formatdomain.html">domain configuration</a>
-        at the time the checkpoint was created. This element may be
-        omitted for output brevity by supplying
-        the <code>VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN</code> flag, but
-        the resulting XML is no longer viable for use with
-        the <code>VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE</code> flag
-        of <code>virDomainCheckpointCreateXML()</code>. The domain
-        will have security-sensitive information omitted unless the
-        flag <code>VIR_DOMAIN_CHECKPOINT_XML_SECURE</code> is provided
-        on a read-write connection.
-      </dd>
-    </dl>
-
-    <h2><a id="example">Examples</a></h2>
-
-    <p>Using this XML to create a checkpoint of just vda on a qemu
-      domain with two disks and a prior checkpoint:</p>
-    <pre>
-&lt;domaincheckpoint&gt;
-  &lt;description&gt;Completion of updates after OS install&lt;/description&gt;
-  &lt;disks&gt;
-    &lt;disk name='vda' checkpoint='bitmap'/&gt;
-    &lt;disk name='vdb' checkpoint='no'/&gt;
-  &lt;/disks&gt;
-&lt;/domaincheckpoint&gt;</pre>
-
-    <p>will result in XML similar to this from
-      <code>virDomainCheckpointGetXMLDesc()</code>:</p>
-    <pre>
-&lt;domaincheckpoint&gt;
-  &lt;name&gt;1525889631&lt;/name&gt;
-  &lt;description&gt;Completion of updates after OS install&lt;/description&gt;
-  &lt;parent&gt;
-    &lt;name&gt;1525111885&lt;/name&gt;
-  &lt;/parent&gt;
-  &lt;creationTime&gt;1525889631&lt;/creationTime&gt;
-  &lt;disks&gt;
-    &lt;disk name='vda' checkpoint='bitmap' bitmap='1525889631'/&gt;
-    &lt;disk name='vdb' checkpoint='no'/&gt;
-  &lt;/disks&gt;
-  &lt;domain type='qemu'&gt;
-    &lt;name&gt;fedora&lt;/name&gt;
-    &lt;uuid&gt;93a5c045-6457-2c09-e56c-927cdf34e178&lt;/uuid&gt;
-    &lt;memory&gt;1048576&lt;/memory&gt;
-    ...
-    &lt;devices&gt;
-      &lt;disk type='file' device='disk'&gt;
-        &lt;driver name='qemu' type='qcow2'/&gt;
-        &lt;source file='/path/to/file1'/&gt;
-        &lt;target dev='vda' bus='virtio'/&gt;
-      &lt;/disk&gt;
-      &lt;disk type='file' device='disk' snapshot='external'&gt;
-        &lt;driver name='qemu' type='raw'/&gt;
-        &lt;source file='/path/to/file2'/&gt;
-        &lt;target dev='vdb' bus='virtio'/&gt;
-      &lt;/disk&gt;
-      ...
-    &lt;/devices&gt;
-  &lt;/domain&gt;
-&lt;/domaincheckpoint&gt;</pre>
-
-    <p>With that checkpoint created, the qcow2 image is now tracking
-      all changes that occur in the image since the checkpoint via
-      the persistent bitmap named <code>1525889631</code>.
-    </p>
-  </body>
-</html>

docs/formatdomain.html.in

@@ -22,7 +22,7 @@
       <a id="attributeDomainType"><code>type</code></a>
       specifies the hypervisor used for running
       the domain. The allowed values are driver specific, but
-      include "xen", "kvm", "qemu" and "lxc". The
+      include "xen", "kvm", "qemu", "lxc" and "kqemu". The
       second attribute is <code>id</code> which is a unique
       integer identifier for the running guest machine. Inactive
       machines have no id value.
@@ -128,7 +128,7 @@
 
 <pre>
 ...
-&lt;os firmware='efi'&gt;
+&lt;os&gt;
   &lt;type&gt;hvm&lt;/type&gt;
   &lt;loader readonly='yes' secure='no' type='rom'&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
   &lt;nvram template='/usr/share/OVMF/OVMF_VARS.fd'&gt;/var/lib/libvirt/nvram/guest_VARS.fd&lt;/nvram&gt;
@@ -141,29 +141,6 @@
 ...</pre>
 
     <dl>
-      <dt><code>firmware</code></dt>
-      <dd>The <code>firmware</code> attribute allows management
-        applications to automatically fill <code>&lt;loader/&gt;</code>
-        and <code>&lt;nvram/&gt;</code> elements and possibly enable
-        some features required by selected firmware. Accepted values are
-        <code>bios</code> and <code>efi</code>.<br/>
-        The selection process scans for files describing installed
-        firmware images in specified location and uses the most specific
-        one which fulfils domain requirements. The locations in order of
-        preference (from generic to most specific one) are:
-        <ul>
-          <li><code>/usr/share/qemu/firmware</code></li>
-          <li><code>/etc/qemu/firmware</code></li>
-          <li><code>$XDG_CONFIG_HOME/qemu/firmware</code></li>
-        </ul>
-        For more information refer to firmware metadata specification as
-        described in <code>docs/interop/firmware.json</code> in QEMU
-        repository. Regular users do not need to bother.
-        <span class="since">Since 5.2.0 (QEMU and KVM only)</span><br/>
-        For VMware guests, this is set to <code>efi</code> when the guest
-        uses UEFI, and it is not set when using BIOS.
-        <span class="since">Since 5.3.0 (VMware ESX and Workstation/Player)</span>
-      </dd>
       <dt><code>type</code></dt>
       <dd>The content of the <code>type</code> element specifies the
         type of operating system to be booted in the virtual machine.
@@ -175,11 +152,7 @@
         and <a id="attributeOSTypeMachine"><code>machine</code></a> referring
         to the machine type. The <a href="formatcaps.html">Capabilities XML</a>
         provides details on allowed values for
-        these. If <code>arch</code> is omitted then for most hypervisor
-        drivers, the host native arch will be chosen. For the <code>test</code>,
-        <code>ESX</code> and <code>VMWare</code> hypervisor drivers, however,
-        the <code>i686</code> arch will always be chosen even on an
-        <code>x86_64</code> host. <span class="since">Since 0.0.1</span></dd>
+        these. <span class="since">Since 0.0.1</span></dd>
       <dt><a id="elementLoader"><code>loader</code></a></dt>
       <dd>The optional <code>loader</code> tag refers to a firmware blob,
         which is specified by absolute path,
@@ -367,8 +340,7 @@
       <dd>The <code>table</code> element contains a fully-qualified path
         to the ACPI table. The <code>type</code> attribute contains the
         ACPI table type (currently only <code>slic</code> is supported)
-        <span class="since">Since 1.3.5 (QEMU)</span>
-        <span class="since">Since 5.9.0 (Xen)</span></dd>
+        <span class="since">Since 1.3.5 (QEMU only)</span></dd>
     </dl>
 
     <h4><a id="elementsOSContainer">Container boot</a></h4>
@@ -943,22 +915,16 @@
         <span class="since">Only QEMU driver support since 2.1.0</span>
       </dd>
 
-      <dt><code>vcpusched</code>, <code>iothreadsched</code>
-      and <code>emulatorsched</code></dt>
+      <dt><code>vcpusched</code> and <code>iothreadsched</code></dt>
       <dd>
-        The optional
-        <code>vcpusched</code>, <code>iothreadsched</code>
-        and <code>emulatorsched</code> elements specify the scheduler type
-        (values <code>batch</code>, <code>idle</code>, <code>fifo</code>,
-        <code>rr</code>) for particular vCPU, IOThread and emulator threads
-        respecively.  For <code>vcpusched</code> and <code>iothreadsched</code>
-        the attributes <code>vcpus</code> and <code>iothreads</code> select
-        which vCPUs/IOThreads this setting applies to, leaving them out sets the
-        default.  The element <code>emulatorsched</code> does not have that
-        attribute. Valid <code>vcpus</code> values start at 0 through one less
-        than the number of vCPU's defined for the
-        domain. Valid <code>iothreads</code> values are described in
-        the <code>iothreadids</code>
+        The optional <code>vcpusched</code> elements specifies the scheduler
+        type (values <code>batch</code>, <code>idle</code>, <code>fifo</code>,
+        <code>rr</code>) for particular vCPU/IOThread threads (based on
+        <code>vcpus</code> and <code>iothreads</code>, leaving out
+        <code>vcpus</code>/<code>iothreads</code> sets the default). Valid
+        <code>vcpus</code> values start at 0 through one less than the
+        number of vCPU's defined for the domain. Valid <code>iothreads</code>
+        values are described in the <code>iothreadids</code>
         <a href="#elementsIOThreadsAllocation"><code>description</code></a>.
         If no <code>iothreadids</code> are defined, then libvirt numbers
         IOThreads from 1 to the number of <code>iothreads</code> available
@@ -967,7 +933,6 @@
         well (and is ignored for non-real-time ones). The value range
         for the priority depends on the host kernel (usually 1-99).
         <span class="since">Since 1.2.13</span>
-        <code>emulatorsched</code> <span class="since">since 5.3.0</span>
       </dd>
 
       <dt><code>cachetune</code><span class="since">Since 4.1.0</span></dt>
@@ -1595,8 +1560,8 @@
           hand, the ABI provided to the guest is reproducible. During
           migration, complete CPU model definition is transferred to the
           destination host so the migrated guest will see exactly the same CPU
-          model for the running instance of the guest, even if the destination
-          host contains more capable CPUs or newer kernel; but shutting down and restarting
+          model even if the destination host contains more capable CPUs for
+          the running instance of the guest; but shutting down and restarting
           the guest may present different hardware to the guest according to
           the capabilities of the new host. Prior to libvirt 3.2.0 and QEMU
           2.9.0 detection of the host CPU model via QEMU is not supported.
@@ -1630,10 +1595,10 @@
           environment cannot be reproduced on different hardware. Thus, if you
           hit any bugs, you are on your own. Further details of that CPU can
           be changed using <code>feature</code> elements. Migration of a guest
-          using host-passthrough is dangerous if the source and destination hosts
-          are not identical in both hardware, QEMU version, microcode version
-          and configuration. If such a migration is attempted then the guest may
-          hang or crash upon resuming execution on the destination host.</dd>
+          using host-passthrough is dangerous if the source and destination
+          hosts are not identical in both hardware and configuration. If such
+          a migration is attempted then the guest may hang or crash upon
+          resuming execution on the destination host.</dd>
         </dl>
 
         Both <code>host-model</code> and <code>host-passthrough</code> modes
@@ -1964,7 +1929,7 @@
       <span class="since">Since 3.9.0</span>, the lifecycle events can
       be configured via the
       <a href="html/libvirt-libvirt-domain.html#virDomainSetLifecycleAction">
-        <code>virDomainSetLifecycleAction</code></a> API.
+        <code>virDomainSetLifecycleAction</code></a> API.
     </p>
 
     <p>
@@ -2038,9 +2003,6 @@
     &lt;vpindex state='on'/&gt;
     &lt;runtime state='on'/&gt;
     &lt;synic state='on'/&gt;
-    &lt;stimer state='on'&gt;
-      &lt;direct state='on'/&gt;
-    &lt;/stimer&gt;
     &lt;reset state='on'/&gt;
     &lt;vendor_id state='on' value='KVM Hv'/&gt;
     &lt;frequencies state='on'/&gt;
@@ -2051,7 +2013,6 @@
   &lt;/hyperv&gt;
   &lt;kvm&gt;
     &lt;hidden state='on'/&gt;
-    &lt;hint-dedicated state='on'/&gt;
   &lt;/kvm&gt;
   &lt;pvspinlock state='on'/&gt;
   &lt;gic version='2'/&gt;
@@ -2064,8 +2025,6 @@
     &lt;tseg unit='MiB'&gt;48&lt;/tseg&gt;
   &lt;/smm&gt;
   &lt;htm state='on'/&gt;
-  &lt;ccf-assist state='on'/&gt;
-  &lt;msrs unknown='ignore'/&gt;
 &lt;/features&gt;
 ...</pre>
 
@@ -2151,15 +2110,15 @@
         </tr>
         <tr>
           <td>synic</td>
-          <td>Enable Synthetic Interrupt Controller (SynIC)</td>
+          <td>Enable Synthetic Interrupt Controller (SyNIC)</td>
           <td>on, off</td>
           <td><span class="since">1.3.3 (QEMU 2.6)</span></td>
         </tr>
         <tr>
           <td>stimer</td>
-          <td>Enable SynIC timers, optionally with Direct Mode support</td>
-          <td>on, off; direct - on,off</td>
-          <td><span class="since">1.3.3 (QEMU 2.6), direct mode 5.7.0 (QEMU 4.1)</span></td>
+          <td>Enable SyNIC timers</td>
+          <td>on, off</td>
+          <td><span class="since">1.3.3 (QEMU 2.6)</span></td>
         </tr>
         <tr>
           <td>reset</td>
@@ -2226,12 +2185,6 @@
           <td>on, off</td>
           <td><span class="since">1.2.8 (QEMU 2.1.0)</span></td>
         </tr>
-        <tr>
-          <td>hint-dedicated</td>
-          <td>Allows a guest to enable optimizations when running on dedicated vCPUs</td>
-          <td>on, off</td>
-          <td><span class="since">5.7.0 (QEMU 2.12.0)</span></td>
-        </tr>
       </table>
       </dd>
       <dt><code>pmu</code></dt>
@@ -2354,23 +2307,6 @@
           defined, the hypervisor default will be used.
           <span class="since">Since 4.10.0</span> (QEMU/KVM only)
       </dd>
-      <dt><code>msrs</code></dt>
-      <dd>Some guests might require ignoring unknown
-          Model Specific Registers (MSRs) reads and writes. It's possible
-          to switch this by setting <code>unknown</code> attribute
-          of <code>msrs</code> to <code>ignore</code>. If the attribute is
-          not defined, or set to <code>fault</code>, unknown reads and writes
-          will not be ignored.
-          <span class="since">Since 5.1.0</span> (bhyve only)
-      </dd>
-      <dt><code>ccf-assist</code></dt>
-      <dd>Configure ccf-assist (Count Cache Flush Assist) availability for
-          pSeries guests.
-          Possible values for the <code>state</code> attribute
-          are <code>on</code> and <code>off</code>. If the attribute is not
-          defined, the hypervisor default will be used.
-          <span class="since">Since 5.9.0</span> (QEMU/KVM only)
-      </dd>
     </dl>
 
     <h3><a id="elementsTime">Time keeping</a></h3>
@@ -2463,9 +2399,7 @@
             being modified, and can be one of
             "platform" (currently unsupported),
             "hpet" (libxl, xen, qemu), "kvmclock" (qemu),
-            "pit" (qemu), "rtc" (qemu), "tsc" (libxl, qemu -
-            <span class="since">since 3.2.0</span>)
-            or "hypervclock"
+            "pit" (qemu), "rtc" (qemu), "tsc" (libxl) or "hypervclock"
             (qemu - <span class="since">since 1.2.2</span>).
 
             The <code>hypervclock</code> timer adds support for the
@@ -2948,13 +2882,6 @@
     &lt;/backingStore&gt;
     &lt;target dev='vdd' bus='virtio'/&gt;
   &lt;/disk&gt;
-  &lt;disk type='nvme' device='disk'&gt;
-    &lt;driver name='qemu' type='raw'/&gt;
-    &lt;source type='pci' managed='yes' namespace='1'&gt;
-      &lt;address domain='0x0000' bus='0x01' slot='0x00' function='0x0'/&gt;
-    &lt;/source&gt;
-    &lt;target dev='vde' bus='virtio'/&gt;
-  &lt;/disk&gt;
 &lt;/devices&gt;
 ...</pre>
 
@@ -2968,8 +2895,7 @@
             Valid values are "file", "block",
             "dir" (<span class="since">since 0.7.5</span>),
             "network" (<span class="since">since 0.8.7</span>), or
-            "volume" (<span class="since">since 1.0.5</span>), or
-            "nvme" (<span class="since">since 6.0.0</span>)
+            "volume" (<span class="since">since 1.0.5</span>)
             and refer to the underlying source for the disk.
             <span class="since">Since 0.0.3</span>
             </dd>
@@ -2996,17 +2922,6 @@
             <span class="since">Since 0.1.4</span>
             </p>
             </dd>
-          <dt><code>model</code></dt>
-            <dd>
-            Indicates the emulated device model of the disk. Typically
-            this is indicated solely by the <code>bus</code> property but
-            for <code>bus</code> "virtio" the model can be specified further
-            with "virtio-transitional", "virtio-non-transitional", or
-            "virtio". See
-            <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-            for more details.
-            <span class="since">Since 5.2.0</span>
-            </dd>
           <dt><code>rawio</code></dt>
             <dd>
             Indicates whether the disk needs rawio capability. Valid
@@ -3152,43 +3067,6 @@
               <span class="since">Since 1.0.5</span>
               </p>
               </dd>
-            <dt><code>nvme</code></dt>
-              <dd>
-              To specify disk source for NVMe disk the <code>source</code>
-              element has the following attributes:
-              <dl>
-                <dt><code>type</code></dt>
-                <dd>The type of address specified in <code>address</code>
-                sub-element. Currently, only <code>pci</code> value is
-                accepted.
-                </dd>
-
-                <dt><code>managed</code></dt>
-                <dd>This attribute instructs libvirt to detach NVMe
-                controller automatically on domain startup (<code>yes</code>)
-                or expect the controller to be detached by system
-                administrator (<code>no</code>).
-                </dd>
-
-                <dt><code>namespace</code></dt>
-                <dd>The namespace ID which should be assigned to the domain.
-                According to NVMe standard, namespace numbers start from 1,
-                including.
-                </dd>
-              </dl>
-
-              The difference between <code>&lt;disk type='nvme'&gt;</code>
-              and <code>&lt;hostdev/&gt;</code> is that the latter is plain
-              host device assignment with all its limitations (e.g. no live
-              migration), while the former makes hypervisor to run the NVMe
-              disk through hypervisor's block layer thus enabling all
-              features provided by the layer (e.g. snapshots, domain
-              migration, etc.). Moreover, since the NVMe disk is unbinded
-              from its PCI driver, the host kernel storage stack is not
-              involved (compared to passing say <code>/dev/nvme0n1</code> via
-              <code>&lt;disk type='block'&gt;</code> and therefore lower
-              latencies can be achieved.
-              </dd>
           </dl>
         With "file", "block", and "volume", one or more optional
         sub-elements <code>seclabel</code>, <a href="#seclabel">described
@@ -3351,12 +3229,6 @@
             initiator IQN needed to access the source via mandatory
             attribute <code>name</code>.
           </dd>
-          <dt><code>address</code></dt>
-          <dd>For disk of type <code>nvme</code> this element
-            specifies the PCI address of the host NVMe
-            controller.
-            <span class="since">Since 6.0.0</span>
-          </dd>
         </dl>
 
         <p>
@@ -3395,26 +3267,15 @@
       <dt><code>backingStore</code></dt>
       <dd>
         This element describes the backing store used by the disk
-        specified by sibling <code>source</code> element.
-        <span class="since">Since 1.2.4.</span>
-
-        If the hypervisor driver does not support the
-        <a href='formatdomaincaps.html#featureBackingStoreInput'>
-        <code>backingStoreInput</code></a>
-        (<span class='since'>Since 5.10.0</span>)
-        domain feature the <code>backingStore</code> is ignored on
-        input and only used for output to describe the detected
-        backing chains of running domains.
-
-        If <code>backingStoreInput</code> is supported
-        the <code>backingStore</code> is used as the backing image of
-        <code>source</code> or other <code>backingStore</code> overriding
-        any backing image information recorded in the image metadata.
-
-        An empty <code>backingStore</code> element means the sibling
-        source is self-contained and is not based on any backing store.
-
-        For the detected backing chain information to be accurate, the
+        specified by sibling <code>source</code> element. It is
+        currently ignored on input and only used for output to
+        describe the detected backing chains of running
+        domains <span class="since">since 1.2.4</span> (although a
+        future version of libvirt may start accepting chains on input,
+        or output information for offline domains). An
+        empty <code>backingStore</code> element means the sibling
+        source is self-contained and is not based on any backing
+        store. For backing chain information to be accurate, the
         backing format must be correctly specified in the metadata of
         each file of the chain (files created by libvirt satisfy this
         property, but using existing external files for snapshot or
@@ -3913,7 +3774,7 @@
     &lt;readonly/&gt;
   &lt;/filesystem&gt;
   &lt;filesystem type='file' accessmode='passthrough'&gt;
-    &lt;driver type='loop' format='raw'/&gt;
+    &lt;driver name='loop' type='raw'/&gt;
     &lt;driver type='path' wrpolicy='immediate'/&gt;
     &lt;source file='/export/to/guest.img'/&gt;
     &lt;target dir='/import/from/host'/&gt;
@@ -3979,7 +3840,7 @@
           <span class="since"> (since 0.9.13)</span></dd>
         </dl>
 
-      The filesystem element has an optional attribute <code>accessmode</code>
+      The filesystem block has an optional attribute <code>accessmode</code>
       which specifies the security mode for accessing the source
       <span class="since">(since 0.8.5)</span>. Currently this only works
       with <code>type='mount'</code> for the QEMU/KVM driver. The possible
@@ -4009,11 +3870,6 @@
         </dd>
         </dl>
 
-      <span class="since">Since 5.2.0</span>, the filesystem element
-      has an optional attribute <code>model</code> with supported values
-      "virtio-transitional", "virtio-non-transitional", or "virtio".
-      See <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-      for more details.
       </dd>
 
       <dt><code>driver</code></dt>
@@ -4164,9 +4020,9 @@
       </dd>
       <dt><code>spapr-vio</code></dt>
       <dd>On PowerPC pseries guests, devices can be assigned to the
-        SPAPR-VIO bus.  It has a flat 32-bit address space; by
+        SPAPR-VIO bus.  It has a flat 64-bit address space; by
         convention, devices are generally assigned at a non-zero
-        multiple of 0x00001000, but other addresses are valid and
+        multiple of 0x1000, but other addresses are valid and
         permitted by libvirt.  Each address has the following
         additional attribute: <code>reg</code> (the hex value address
         of the starting register).  <span class="since">Since
@@ -4203,16 +4059,6 @@
         attributes: <code>iobase</code> and <code>irq</code>.
         <span class="since">Since 1.2.1</span>
       </dd>
-      <dt><code>unassigned</code></dt>
-      <dd>For PCI hostdevs, <code>&lt;address type='unassigned'/&gt;</code>
-        allows the admin to include a PCI hostdev in the domain XML definition,
-        without making it available for the guest. This allows for configurations
-        in which Libvirt manages the device as a regular PCI hostdev,
-        regardless of whether the guest will have access to it.
-        <code>&lt;address type='unassigned'/&gt;</code> is an invalid address
-        type for all other device types.
-        <span class="since">Since 6.0.0</span>
-      </dd>
     </dl>
 
     <h4><a id="elementsVirtio">Virtio-related options</a></h4>
@@ -4228,63 +4074,6 @@
       <span class="since">Since 3.5.0</span>
     </p>
 
-    <h4><a id="elementsVirtioTransitional">Virtio transitional devices</a></h4>
-
-    <p>
-      <span class="since">Since 5.2.0</span>, some of QEMU's virtio devices,
-      when used with PCI/PCIe machine types, accept the following
-      <code>model</code> values:
-    </p>
-
-    <dl>
-      <dt><code>virtio-transitional</code></dt>
-      <dd>This device can work both with virtio 0.9 and virtio 1.0 guest
-      drivers, so it's the best choice when compatibility with older
-      guest operating systems is desired. libvirt will plug the device
-      into a conventional PCI slot.
-      </dd>
-      <dt><code>virtio-non-transitional</code></dt>
-      <dd>This device can only work with virtio 1.0 guest drivers, and it's
-      the recommended option unless compatibility with older guest
-      operating systems is necessary. libvirt will plug the device into
-      either a PCI Express slot or a conventional PCI slot based on the
-      machine type, resulting in a more optimized PCI topology.
-      </dd>
-      <dt><code>virtio</code></dt>
-      <dd>This device will work like a <code>virtio-non-transitional</code>
-      device when plugged into a PCI Express slot, and like a
-      <code>virtio-transitional</code> device otherwise; libvirt will
-      pick one or the other based on the machine type. This is the best
-      choice when compatibility with libvirt versions older than 5.2.0
-      is necessary, but it's otherwise not recommended to use it.
-      </dd>
-    </dl>
-
-    <p>
-      While the information outlined above applies to most virtio devices,
-      there are a few exceptions:
-    </p>
-
-    <ul>
-      <li>
-        for SCSI controllers, <code>virtio-scsi</code> must be used instead
-        of <code>virtio</code> for backwards compatibility reasons;
-      </li>
-      <li>
-        some devices, such as GPUs and input devices (keyboard, tablet and
-        mouse), are only defined in the virtio 1.0 spec and as such don't
-        have a transitional variant: the only accepted model is
-        <code>virtio</code>, which will result in a non-transitional device.
-      </li>
-    </ul>
-
-    <p>
-      For more details see the
-      <a href="https://lists.gnu.org/archive/html/qemu-devel/2018-12/msg00923.html">qemu patch posting</a> and the
-      <a href="http://docs.oasis-open.org/virtio/virtio/v1.0/virtio-v1.0.html">virtio-1.0 spec</a>.
-    </p>
-
-
     <h4><a id="elementsControllers">Controllers</a></h4>
 
     <p>
@@ -4309,7 +4098,6 @@
     &lt;driver iothread='4'/&gt;
     &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x0b' function='0x0'/&gt;
   &lt;/controller&gt;
-  &lt;controller type='xenbus' maxGrantFrames='64'/&gt;
   ...
 &lt;/devices&gt;
 ...</pre>
@@ -4333,20 +4121,12 @@
         <dd>The <code>virtio-serial</code> controller has two additional
         optional attributes <code>ports</code> and <code>vectors</code>,
         which control how many devices can be connected through the
-        controller. <span class="since">Since 5.2.0</span>, it
-        supports an optional attribute <code>model</code> which can
-        be 'virtio', 'virtio-transitional', or 'virtio-non-transitional'. See
-        <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-        for more details.
-        </dd>
+        controller.</dd>
         <dt><code>scsi</code></dt>
         <dd>A <code>scsi</code> controller has an optional attribute
         <code>model</code>, which is one of 'auto', 'buslogic', 'ibmvscsi',
-        'lsilogic', 'lsisas1068', 'lsisas1078', 'virtio-scsi',
-        'vmpvscsi', 'virtio-transitional', 'virtio-non-transitional'. See
-        <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-        for more details.
-        </dd>
+        'lsilogic', 'lsisas1068', 'lsisas1078', 'virtio-scsi' or
+        'vmpvscsi'.</dd>
         <dt><code>usb</code></dt>
         <dd>A <code>usb</code> controller has an optional attribute
         <code>model</code>, which is one of "piix3-uhci", "piix4-uhci",
@@ -4365,11 +4145,6 @@
         <dd><span class="since">Since 3.10.0</span> for the vbox driver, the
         <code>ide</code> controller has an optional attribute
         <code>model</code>, which is one of "piix3", "piix4" or "ich6".</dd>
-        <dt><code>xenbus</code></dt>
-        <dd><span class="since">Since 5.2.0</span>, the <code>xenbus</code>
-        controller has an optional attribute <code>maxGrantFrames</code>,
-        which specifies the maximum number of grant frames the controller
-        makes available for connected devices.</dd>
       </dl>
 
     <p>
@@ -4512,7 +4287,7 @@
       subelement <code>&lt;model&gt;</code> with an attribute
       <code>name</code>. The name attribute holds the name of the
       specific device that qemu is emulating (e.g. "i82801b11-bridge")
-      rather than simply the class of device ("pcie-to-pci-bridge",
+      rather than simply the class of device ("dmi-to-pci-bridge",
       "pci-bridge"), which is set in the controller element's
       model <b>attribute</b>.  In almost all cases, you should not
       manually add a <code>&lt;model&gt;</code> subelement to a
@@ -4701,11 +4476,11 @@
 ...
 &lt;devices&gt;
   &lt;controller type='pci' index='0' model='pcie-root'/&gt;
-  &lt;controller type='pci' index='1' model='pcie-root-port'&gt;
-    &lt;address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x0'/&gt;
+  &lt;controller type='pci' index='1' model='dmi-to-pci-bridge'&gt;
+    &lt;address type='pci' domain='0' bus='0' slot='0xe' function='0'/&gt;
   &lt;/controller&gt;
-  &lt;controller type='pci' index='2' model='pcie-to-pci-bridge'&gt;
-    &lt;address type='pci' domain='0x0000' bus='0x01' slot='0x00' function='0x0'/&gt;
+  &lt;controller type='pci' index='2' model='pci-bridge'&gt;
+    &lt;address type='pci' domain='0' bus='1' slot='1' function='0'/&gt;
   &lt;/controller&gt;
 &lt;/devices&gt;
 ...</pre>
@@ -4895,12 +4670,7 @@
           <dd><span class="since">since 2.5.0</span>For SCSI devices, user
             is responsible to make sure the device is not used by host. This
             <code>type</code> passes all LUNs presented by a single HBA to
-            the guest. <span class="since">Since 5.2.0,</span> the
-            <code>model</code> attribute can be specified further
-            with "virtio-transitional", "virtio-non-transitional", or
-            "virtio". See
-            <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-            for more details.
+            the guest.
           </dd>
           <dt><code>mdev</code></dt>
           <dd>For mediated devices (<span class="since">Since 3.2.0</span>)
@@ -4923,14 +4693,6 @@
           <a href="#elementsGraphics">graphical framebuffer</a> in order to
           use this attribute, currently only supported with VNC, Spice and
           egl-headless graphics devices.
-
-          <span class="since">Since version 5.10.0</span>, there is an optional
-          <code>ramfb</code> attribute for devices with
-          <code>model='vfio-pci'</code>. Supported values are either
-          <code>on</code> or <code>off</code> (default is 'off').  When
-          enabled, this attribute provides a memory framebuffer device to the
-          guest.  This framebuffer will be used as a boot display when a vgpu
-          device is the primary display.
           <p>
             Note: There are also some implications on the usage of guest's
             address type depending on the <code>model</code> attribute,
@@ -5415,14 +5177,6 @@
       information for different classes of network
       connections. <span class="since">Since 0.9.4</span>.
     </p>
-    <p>
-      When a guest is running an interface of type <code>network</code>
-      may include a <code>portid</code> attribute. This provides the UUID
-      of an associated virNetworkPortPtr object that records the association
-      between the domain interface and the network. This attribute is
-      read-only since port objects are create and deleted automatically
-      during startup and shutdown. <span class="since">Since 5.1.0</span>
-    </p>
     <p>
       Also, similar to <code>direct</code> network connections
       (described below), a connection of type <code>network</code> may
@@ -5605,51 +5359,23 @@
     <h5><a id="elementsNICSEthernet">Generic ethernet connection</a></h5>
 
     <p>
-      Provides a means to use a new or existing tap device (or veth
-      device pair, depening on the needs of the hypervisor driver)
-      that is partially or wholly setup external to libvirt (either
-      prior to the guest starting, or while the guest is being started
-      via an optional script specified in the config).
-    </p>
-    <p>
-      The name of the tap device can optionally be specified with
-      the <code>dev</code> attribute of the
-      <code>&lt;target&gt;</code> element. If no target dev is
-      specified, libvirt will create a new standard tap device with a
-      name of the pattern "vnetN", where "N" is replaced with a
-      number. If a target dev is specified and that device doesn't
-      exist, then a new standard tap device will be created with the
-      exact dev name given. If the specified target dev does exist,
-      then that existing device will be used. Usually some basic setup
-      of the device is done by libvirt, including setting a MAC
-      address, and the IFF_UP flag, but if the <code>dev</code> is a
-      pre-existing device, and the <code>managed</code> attribute of
-      the <code>target</code> element is also set to "no" (the default
-      value is "yes"), even this basic setup will not be performed -
-      libvirt will simply pass the device on to the hypervisor with no
-      setup at all. <span class="since">Since 5.7.0</span> Using
-      managed='no' with a pre-created tap device is useful because
-      it permits a virtual machine managed by an unprivileged libvirtd
-      to have emulated network devices based on tap devices.
-    </p>
-    <p>
-      After creating/opening the tap device, an optional shell script
-      (given in the <code>path</code> attribute of
-      the <code>&lt;script&gt;</code> element) will be run; this can
-      be used to do whatever extra host network integration is
-      required.
+      Provides a means for the administrator to execute an arbitrary script
+      to connect the guest's network to the LAN. The guest will have a tun
+      device created with a name of vnetN, which can also be overridden with the
+      &lt;target&gt; element. After creating the tun device a shell script will
+      be run which is expected to do whatever host network integration is
+      required. By default this script is called /etc/qemu-ifup but can be
+      overridden.
     </p>
 
 <pre>
 ...
 &lt;devices&gt;
-  &lt;interface type='ethernet'&gt;
-    &lt;script path='/etc/qemu-ifup-mynet'/&gt;
-  &lt;/interface&gt;
+  &lt;interface type='ethernet'/&gt;
   ...
   &lt;interface type='ethernet'&gt;
-    &lt;target dev='mytap1' managed='no'/&gt;
-    &lt;model type='virtio'/&gt;
+    &lt;target dev='vnet7'/&gt;
+    &lt;script path='/etc/qemu-ifup-mynet'/&gt;
   &lt;/interface&gt;
 &lt;/devices&gt;
 ...</pre>
@@ -5978,11 +5704,7 @@ qemu-kvm -net nic,model=? /dev/null
 
     <p>
       Typical values for QEMU and KVM include:
-      ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio.
-      <span class="since">Since 5.2.0</span>, <code>virtio-transitional</code>
-      and <code>virtio-non-transitional</code> values are supported.
-      See <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-      for more details.
+      ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio
     </p>
 
     <h5><a id="elementsDriverBackendOptions">Setting NIC driver-specific options</a></h5>
@@ -6692,12 +6414,6 @@ qemu-kvm -net nic,model=? /dev/null
       For type <code>passthrough</code>, the mandatory sub-element <code>source</code>
       must have an <code>evdev</code> attribute containing the absolute path to the
       event device passed through to guests. (KVM only)
-
-      <span class="since">Since 5.2.0</span>, the <code>input</code> element
-      accepts a <code>model</code> attribute which has the values 'virtio',
-      'virtio-transitional' and 'virtio-non-transitional'. See
-      <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-      for more details.
     </p>
 
     <p>
@@ -7091,7 +6807,6 @@ qemu-kvm -net nic,model=? /dev/null
     &lt;model type='vga' vram='16384' heads='1'&gt;
       &lt;acceleration accel3d='yes' accel2d='yes'/&gt;
     &lt;/model&gt;
-    &lt;driver name='qemu'/&gt;
   &lt;/video&gt;
 &lt;/devices&gt;
 ...</pre>
@@ -7125,11 +6840,9 @@ qemu-kvm -net nic,model=? /dev/null
           attribute which takes the value "vga", "cirrus", "vmvga", "xen",
           "vbox", "qxl" (<span class="since">since 0.8.6</span>),
           "virtio" (<span class="since">since 1.3.0</span>),
-          "gop" (<span class="since">since 3.2.0</span>),
-          "bochs" (<span class="since">since 5.6.0</span>), "ramfb"
-          (<span class="since">since 5.9.0</span>), or "none"
-          (<span class="since">since 4.6.0</span>,  depending on the hypervisor
-          features available.
+          "gop" (<span class="since">since 3.2.0</span>), or
+          "none" (<span class="since">since 4.6.0</span>)
+          depending on the hypervisor features available.
           The purpose of the type <code>none</code> is to instruct libvirt not
           to add a default video device in the guest (see the paragraph above).
           This legacy behaviour can be inconvenient in cases where GPU mediated
@@ -7163,13 +6876,6 @@ qemu-kvm -net nic,model=? /dev/null
           Attribute <code>vram64</code> (<span class="since">since 1.3.3</span>)
           extends secondary bar and makes it addressable as 64bit memory.
         </p>
-        <p><span class="since">Since 5.9.0</span>, the <code>model</code>
-        element may also have an optional <code>resolution</code> sub-element.
-        The <code>resolution</code> element has attributes <code>x</code> and
-        <code>y</code> to set the minimum resolution for the video device. This
-        sub-element is valid for model types "vga", "qxl", "bochs", and
-        "virtio".
-        </p>
       </dd>
 
       <dt><code>acceleration</code></dt>
@@ -7184,12 +6890,6 @@ qemu-kvm -net nic,model=? /dev/null
         <dd>Enable 3D acceleration (for vbox driver
         <span class="since">since 0.7.1</span>, qemu driver
         <span class="since">since 1.3.0</span>)</dd>
-
-        <dt><code>rendernode</code></dt>
-        <dd>Absolute path to a host's DRI device to be used for
-        rendering (for 'vhostuser' driver only, <span
-        class="since">since 5.8.0</span>). If none is specified,
-        libvirt will pick one available.</dd>
         </dl>
       </dd>
 
@@ -7206,16 +6906,7 @@ qemu-kvm -net nic,model=? /dev/null
       <dd>
         The subelement <code>driver</code> can be used to tune the device:
         <dl>
-          <dt><code>name</code></dt>
-          <dd>
-            Specify the backend driver to use, either "qemu" or
-            "vhostuser" depending on the hypervisor features available
-            (<span class="since">since 5.8.0</span>).  "qemu" is the
-            default QEMU backend. "vhostuser" will use a separate
-            vhost-user process backend (for <code>virtio</code>
-            device).
-          </dd>
-        <dt>virtio options</dt>
+          <dt>virtio options</dt>
           <dd>
           <a href="#elementsVirtio">Virtio-specific options</a> can also be
           set (<span class="since">Since 3.5.0</span>)
@@ -8194,12 +7885,8 @@ qemu-kvm -net nic,model=? /dev/null
         </p>
         <ul>
           <li>'virtio' - default with QEMU/KVM</li>
-          <li>'virtio-transitional' <span class="since">Since 5.2.0</span></li>
-          <li>'virtio-non-transitional' <span class="since">Since 5.2.0</span></li>
           <li>'xen' - default with Xen</li>
         </ul>
-        See <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-        for more details.
       </dd>
       <dt><code>autodeflate</code></dt>
       <dd>
@@ -8271,11 +7958,7 @@ qemu-kvm -net nic,model=? /dev/null
         </p>
         <ul>
           <li>'virtio' - supported by qemu and virtio-rng kernel module</li>
-          <li>'virtio-transitional' <span class='since'>Since 5.2.0</span></li>
-          <li>'virtio-non-transitional' <span class='since'>Since 5.2.0</span></li>
         </ul>
-        See <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-        for more details.
       </dd>
       <dt><code>rate</code></dt>
       <dd>
@@ -8371,9 +8054,6 @@ qemu-kvm -net nic,model=? /dev/null
       TPM functionality for each VM. QEMU talks to it over a Unix socket. With
       the emulator device type each guest gets its own private TPM.
       <span class="since">'emulator' since 4.5.0</span>
-      The state of the TPM emulator can be encrypted by providing an
-      <code>encryption</code> element.
-      <span class="since">'encryption' since 5.6.0</span>
     </p>
     <p>
      Example: usage of the TPM Emulator
@@ -8383,7 +8063,6 @@ qemu-kvm -net nic,model=? /dev/null
   &lt;devices&gt;
     &lt;tpm model='tpm-tis'&gt;
       &lt;backend type='emulator' version='2.0'&gt;
-        &lt;encryption secret='6dd3e4a5-1d76-44ce-961f-f119f5aad935'/&gt;
       &lt;/backend&gt;
     &lt;/tpm&gt;
   &lt;/devices&gt;
@@ -8446,14 +8125,6 @@ qemu-kvm -net nic,model=? /dev/null
           <li>'2.0' : creates a TPM 2.0</li>
         </ul>
       </dd>
-      <dt><code>encryption</code></dt>
-      <dd>
-        <p>
-          The <code>encryption</code> element allows the state of a TPM emulator
-          to be encrypted. The <code>secret</code> must reference a secret object
-          that holds the passphrase from which the encryption key will be derived.
-        </p>
-      </dd>
     </dl>
 
     <h4><a id="elementsNVRAM">NVRAM device</a></h4>
@@ -8470,7 +8141,7 @@ qemu-kvm -net nic,model=? /dev/null
 ...
 &lt;devices&gt;
   &lt;nvram&gt;
-    &lt;address type='spapr-vio' reg='0x00003000'/&gt;
+    &lt;address type='spapr-vio' reg='0x3000'/&gt;
   &lt;/nvram&gt;
 &lt;/devices&gt;
 ...
@@ -8651,6 +8322,7 @@ qemu-kvm -net nic,model=? /dev/null
   &lt;memory model='nvdimm'&gt;
     &lt;source&gt;
       &lt;path&gt;/tmp/nvdimm&lt;/path&gt;
+      &lt;alignsize unit='KiB'&gt;2048&lt;/alignsize&gt;
     &lt;/source&gt;
     &lt;target&gt;
       &lt;size unit='KiB'&gt;524288&lt;/size&gt;
@@ -8661,10 +8333,9 @@ qemu-kvm -net nic,model=? /dev/null
       &lt;readonly/&gt;
     &lt;/target&gt;
   &lt;/memory&gt;
-  &lt;memory model='nvdimm' access='shared'&gt;
+  &lt;memory model='nvdimm'&gt;
     &lt;source&gt;
       &lt;path&gt;/dev/dax0.0&lt;/path&gt;
-      &lt;alignsize unit='KiB'&gt;2048&lt;/alignsize&gt;
       &lt;pmem/&gt;
     &lt;/source&gt;
     &lt;target&gt;
@@ -8698,8 +8369,6 @@ qemu-kvm -net nic,model=? /dev/null
           module basis. Values are the same as
           <a href="#elementsMemoryBacking">Memory Backing</a>:
           <code>shared</code> and <code>private</code>.
-          For <code>nvdimm</code> model, if using real NVDIMM DAX device as
-          backend, <code>shared</code> is required.
         </p>
       </dd>
 
@@ -8763,8 +8432,7 @@ qemu-kvm -net nic,model=? /dev/null
               alignment used to mmap the address range for the backend
               <code>path</code>. If not supplied the host page size is used.
               For example, to mmap a real NVDIMM device a 2M-aligned page may
-              be required, and host page size is 4KB, then we need to set this
-              element to 2MB.
+              be required.
               <span class="since">Since 5.0.0</span>
             </p>
           </dd>
@@ -8857,17 +8525,14 @@ qemu-kvm -net nic,model=? /dev/null
       <dt><code>model</code></dt>
       <dd>
         <p>
-          Supported values are <code>intel</code> (for Q35 guests) and,
-          <span class="since">since 5.5.0</span>, <code>smmuv3</code> (for
-          ARM virt guests).
+          Currently only the <code>intel</code> model is supported.
         </p>
       </dd>
       <dt><code>driver</code></dt>
       <dd>
         <p>
           The <code>driver</code> subelement can be used to configure
-          additional options, some of which might only be available for
-          certain IOMMU models:
+          additional options:
         </p>
         <dl>
           <dt><code>intremap</code></dt>
@@ -8920,11 +8585,7 @@ qemu-kvm -net nic,model=? /dev/null
     <h3><a id="vsock">Vsock</a></h3>
 
     <p>A vsock host/guest interface. The <code>model</code> attribute
-    defaults to <code>virtio</code>. <span class="since">Since 5.2.0</span>
-    <code>model</code> can also be 'virtio-transitional' and
-    'virtio-non-transitional', see
-    <a href="#elementsVirtioTransitional">Virtio transitional devices</a>
-    for more details.
+    defaults to <code>virtio</code>.
     The optional attribute <code>address</code> of the <code>cid</code>
     element specifies the CID assigned to the guest. If the attribute
     <code>auto</code> is set to <code>yes</code>, libvirt
@@ -9011,8 +8672,7 @@ qemu-kvm -net nic,model=? /dev/null
       </dd>
       <dt><code>model</code></dt>
       <dd>A valid security model name, matching the currently
-      activated security model. Model <code>dac</code> is not available
-      when guest is run by unprivileged user.
+        activated security model
       </dd>
       <dt><code>relabel</code></dt>
       <dd>Either <code>yes</code> or <code>no</code>. This must always
@@ -9110,7 +8770,7 @@ qemu-kvm -net nic,model=? /dev/null
 
     <p>Note: DEA/TDEA is synonymous with DES/TDES.</p>
 
-    <h3><a id="launchSecurity">Launch Security</a></h3>
+    <h3><a id="sev">Launch Security</a></h3>
 
     <p>
        The contents of the <code>&lt;launchSecurity type='sev'&gt;</code> element
@@ -9125,8 +8785,8 @@ qemu-kvm -net nic,model=? /dev/null
        different entity using a different key the encrypted guests data will
        be incorrectly decrypted, leading to unintelligible data.
 
-       For more information see various input parameters and its format see the
-       <a href="https://support.amd.com/TechDocs/55766_SEV-KM_API_Specification.pdf">SEV API spec</a>
+       For more information see various input parameters and its format see the SEV API spec
+       <a href="https://support.amd.com/TechDocs/55766_SEV-KM%20API_Specification.pdf"> https://support.amd.com/TechDocs/55766_SEV-KM%20API_Specification.pdf </a>
        <span class="since">Since 4.4.0</span>
        </p>
     <pre>

docs/formatdomaincaps.html.in

@@ -37,17 +37,6 @@
     management application to choose an appropriate mode for a pass-through
     host device as well as which adapter to utilize.</p>
 
-    <p>Some XML elements may be entirely omitted from the domaincapabilities
-    XML, depending on what the libvirt driver has filled in. Applications
-    should only act on what is explicitly reported in the domaincapabilities
-    XML. For example, if &lt;disk supported='yes'/&gt; is present, you can safely
-    assume the driver supports &lt;disk&gt; devices. If &lt;disk supported='no'/&gt; is
-    present, you can safely assume the driver does NOT support &lt;disk&gt;
-    devices. If the &lt;disk&gt; block is omitted entirely, the driver is not
-    indicating one way or the other whether it supports &lt;disk&gt; devices, and
-    applications should not interpret the missing block to mean any thing in
-    particular.</p>
-
     <h2><a id="elements">Element and attribute overview</a></h2>
 
     <p> A new query interface was added to the virConnect API's to retrieve the
@@ -119,10 +108,6 @@
 &lt;domainCapabilities&gt;
   ...
   &lt;os supported='yes'&gt;
-    &lt;enum name='firmware'&gt;
-      &lt;value&gt;bios&lt;/value&gt;
-      &lt;value&gt;efi&lt;/value&gt;
-    &lt;/enum&gt;
     &lt;loader supported='yes'&gt;
       &lt;value&gt;/usr/share/OVMF/OVMF_CODE.fd&lt;/value&gt;
       &lt;enum name='type'&gt;
@@ -133,61 +118,29 @@
         &lt;value&gt;yes&lt;/value&gt;
         &lt;value&gt;no&lt;/value&gt;
       &lt;/enum&gt;
-      &lt;enum name='secure'&gt;
-        &lt;value&gt;yes&lt;/value&gt;
-        &lt;value&gt;no&lt;/value&gt;
-      &lt;/enum&gt;
     &lt;/loader&gt;
   &lt;/os&gt;
   ...
 &lt;domainCapabilities&gt;
 </pre>
 
-    <p>The <code>firmware</code> enum corresponds to the
-      <code>firmware</code> attribute of the <code>os</code> element in
-      the domain XML. The presence of this enum means libvirt is capable
-      of the so-called firmware auto-selection feature. And the listed
-      firmware values represent the accepted input in the domain
-      XML. Note that the <code>firmware</code> enum reports only those
-      values for which a firmware "descriptor file" exists on the host.
-      Firmware descriptor file is a small JSON document that describes
-      details about a given BIOS or UEFI binary on the host, e.g. the
-      fimware binary path, its architecture, supported machine types,
-      NVRAM template, etc. This ensures that the reported values won't
-      cause a failure on guest boot.
-    </p>
-
     <p>For the <code>loader</code> element, the following can occur:</p>
 
     <dl>
       <dt><code>value</code></dt>
-      <dd>List of known firmware binary paths. Currently this is used
-      only to advertise the known location of OVMF binaries for
-      QEMU. OVMF binaries will only be listed if they actually exist on
-      host.</dd>
+      <dd>List of known loader paths. Currently this is only used
+      to advertise known locations of OVMF binaries for qemu. Binaries
+      will only be listed if they actually exist on disk.</dd>
 
       <dt><code>type</code></dt>
-      <dd>Whether the boot loader is a typical BIOS (<code>rom</code>)
-      or a UEFI firmware (<code>pflash</code>). Each <code>value</code>
-      sub-element under the <code>type</code> enum represents a possible
-      value for the <code>type</code> attribute for the &lt;loader/&gt;
-      element in the domain XML. E.g. the presence
-      of <code>pfalsh</code> under the <code>type</code> enum means that
-      a domain XML can use UEFI firmware via: &lt;loader/&gt;
-      type="pflash" ...&gt;/path/to/the/firmware/binary/&lt;/loader&gt;.
-      </dd>
+      <dd>Whether loader is a typical BIOS (<code>rom</code>) or
+      an UEFI binary (<code>pflash</code>). This refers to
+      <code>type</code> attribute of the &lt;loader/&gt;
+      element.</dd>
 
       <dt><code>readonly</code></dt>
       <dd>Options for the <code>readonly</code> attribute of the
-      &lt;loader/&gt; element in the domain XML.</dd>
-
-      <dt><code>secure</code></dt>
-      <dd>Options for the <code>secure</code> attribute of the
-      &lt;loader/&gt; element in the domain XML. Note that the
-      value <code>yes</code> is listed only if libvirt detects a
-      firmware descriptor file that has path to an OVMF binary that
-      supports Secure boot, and lists its architecture and supported
-      machine type.</dd>
+      &lt;loader/&gt; element.</dd>
     </dl>
 
     <h3><a id="elementsCPU">CPU configuration</a></h3>
@@ -463,41 +416,6 @@
       element.</dd>
     </dl>
 
-
-    <h4><a id="elementsRNG">RNG device</a></h4>
-    <p>RNG device capabilities are exposed under the
-    <code>rng</code> element. For instance:</p>
-
-<pre>
-&lt;domainCapabilities&gt;
-  ...
-  &lt;devices&gt;
-    &lt;rng supported='yes'&gt;
-      &lt;enum name='model'&gt;
-        &lt;value&gt;virtio&lt;/value&gt;
-        &lt;value&gt;virtio-transitional&lt;/value&gt;
-        &lt;value&gt;virtio-non-transitional&lt;/value&gt;
-      &lt;/enum&gt;
-      &lt;enum name='backendModel'&gt;
-        &lt;value&gt;random&lt;/value&gt;
-        &lt;value&gt;egd&lt;/value&gt;
-      &lt;/enum&gt;
-    &lt;/rng&gt;
-    ...
-  &lt;/devices&gt;
-&lt;/domainCapabilities&gt;
-</pre>
-
-    <dl>
-      <dt><code>model</code></dt>
-      <dd>Options for the <code>model</code> attribute of the
-      &lt;rng&gt; element.</dd>
-      <dt><code>backendModel</code></dt>
-      <dd>Options for the <code>model</code> attribute of the
-      &lt;rng&gt;&lt;backend&gt; element.</dd>
-    </dl>
-
-
     <h3><a id="elementsFeatures">Features</a></h3>
 
     <p>One more set of XML elements describe the supported features and
@@ -516,8 +434,6 @@
     &lt;/gic&gt;
     &lt;vmcoreinfo supported='yes'/&gt;
     &lt;genid supported='yes'/&gt;
-    &lt;backingStoreInput supported='yes'/&gt;
-    &lt;backup supported='yes'/&gt;
     &lt;sev&gt;
       &lt;cbitpos&gt;47&lt;/cbitpos&gt;
       &lt;reduced-phys-bits&gt;1&lt;/reduced-phys-bits&gt;
@@ -554,20 +470,6 @@
 
     <p>Reports whether the genid feature can be used by the domain.</p>
 
-    <h4><a id="featureBackingStoreInput">backingStoreInput</a></h4>
-
-    <p>Reports whether the hypervisor will obey the &lt;backingStore&gt;
-    elements configured for a &lt;disk&gt; when booting the guest, hotplugging
-    the disk to a running guest, or similar.
-    </p>
-
-    <h4><a id="featureBackup">backup</a></h4>
-
-    <p>Reports whether the hypervisor supports the backup, checkpoint, and
-    related features. (<code>virDomainBackupBegin</code>,
-    <code>virDomainCheckpointCreateXML</code> etc).
-    </p>
-
     <h4><a id="elementsSEV">SEV capabilities</a></h4>
 
     <p>AMD Secure Encrypted Virtualization (SEV) capabilities are exposed under
@@ -578,9 +480,10 @@
     encrypted with a key unique to that VM.</p>
 
     <p>
-      For more details on the SEV feature, please follow resources in the
-      AMD developer's document store. In order to use SEV with libvirt have
-      a look at <a href="formatdomain.html#launchSecurity">SEV in domain XML</a>
+    For more details on SEV feature see:
+      <a href="https://support.amd.com/TechDocs/55766_SEV-KM%20API_Specification.pdf">
+        SEV API spec</a> and <a href="http://amd-dev.wpengine.netdna-cdn.com/wordpress/media/2013/12/AMD_Memory_Encryption_Whitepaper_v7-Public.pdf">
+        SEV White Paper</a>
     </p>
 
     <dl>

docs/formatnetwork.html.in

@@ -107,13 +107,13 @@
         may also be connected to the LAN. When defining
         a new network with a <code>&lt;forward&gt;</code> mode of
 
-        "nat", "route", or "open" (or an isolated network with
+        "nat" or "route" (or an isolated network with
         no <code>&lt;forward&gt;</code> element), libvirt will
         automatically generate a unique name for the bridge device if
         none is given, and this name will be permanently stored in the
         network configuration so that that the same name will be used
         every time the network is started. For these types of networks
-        (nat, route, open, and isolated), a bridge name beginning with the
+        (nat, routed, and isolated), a bridge name beginning with the
         prefix "virbr" is recommended (and that is what is
         auto-generated), but not enforced.
         Attribute <code>stp</code> specifies if Spanning Tree Protocol
@@ -152,23 +152,6 @@
           <span class="since">Since 1.2.11, requires kernel 3.17 or
           newer</span>
         </p>
-
-        <p>
-          The optional <code>zone</code> attribute of
-          the <code>bridge</code> element is used to specify
-          the <a href="https://firewalld.org">firewalld</a>
-          zone for the bridge of a network with <code>forward</code>
-          mode of "nat", "route", "open", or one with
-          no <code>forward</code> specified. By default, the bridges
-          of all virtual networks with these forward modes are placed
-          in the firewalld zone named "libvirt", which permits
-          incoming DNS, DHCP, TFTP, and SSH to the host from guests on
-          the network. This behavior can be changed either by
-          modifying the libvirt zone (using firewalld management
-          tools), or by placing the network in a different zone (which
-          will also be managed using firewalld tools).
-          <span class="since">Since 5.1.0</span>
-        </p>
       </dd>
 
       <dt><code>mtu</code></dt>
@@ -1096,28 +1079,6 @@
       </dd>
     </dl>
 
-    <h3><a id="elementsNamespaces">Network namespaces</a></h3>
-
-    <p>
-      A special XML namespace is available for passing options directly to the
-      underlying dnsmasq configuration file. Usage of XML namespaces comes with no
-      support guarantees, so use at your own risk.
-    </p>
-
-    <p>
-      This example XML will pass the option strings <code>foo=bar</code> and
-      <code>cname=*.foo.example.com,master.example.com</code> directly to the
-      underlying dnsmasq instance.
-      <pre>
-&lt;network xmlns:dnsmasq='http://libvirt.org/schemas/network/dnsmasq/1.0'&gt;
-  ...
-  &lt;dnsmasq:options&gt;
-    &lt;dnsmasq:option value="foo=bar"/&gt;
-    &lt;dnsmasq:option value="cname=*.foo.example.com,master.example.com"/&gt;
-  &lt;/dnsmasq:options&gt;
-&lt;/network&gt;</pre>
-    </p>
-
     <h2><a id="examples">Example configuration</a></h2>
 
     <h3><a id="examplesNAT">NAT based network</a></h3>

docs/formatnetworkport.html.in

@@ -1,212 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body>
-    <h1>Network XML format</h1>
-
-    <ul id="toc">
-    </ul>
-
-    <p>
-      This page provides an introduction to the network port XML format.
-      This stores information about the connection between a virtual
-      interface of a virtual domain, and the virtual network it is
-      attached to.
-    </p>
-
-    <h2><a id="elements">Element and attribute overview</a></h2>
-
-    <p>
-      The root element required for all virtual network ports is
-      named <code>networkport</code> and has no configurable attributes
-      The network port XML format is available <span class="since">since
-      5.5.0</span>
-    </p>
-
-    <h3><a id="elementsMetadata">General metadata</a></h3>
-
-    <p>
-      The first elements provide basic metadata about the virtual
-      network port.
-    </p>
-
-    <pre>
-&lt;networkport
-  &lt;uuid&gt;7ae63b5f-fe96-4af0-a7c3-da04ba1b3f54&lt;/uuid&gt;
-  &lt;owner&gt;
-    &lt;uuid&gt;06578fc1-c686-46fa-bc2c-220893b466a6&lt;/uuid&gt;
-    &lt;name&gt;myguest&lt;name&gt;
-  &lt;/owner&gt;
-  &lt;group&gt;webfront&lt;group&gt;
-  &lt;mac address='52:54:0:7b:35:93'/&gt;
-  ...</pre>
-
-    <dl>
-      <dt><code>uuid</code></dt>
-      <dd>The content of the <code>uuid</code> element provides
-        a globally unique identifier for the virtual network port.
-        The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
-        If omitted when defining/creating a new network port, a random
-        UUID is generated.</dd>
-      <dd>The <code>owner</code> node records the domain object that
-        is the owner of the network port. It contains two child nodes:
-        <dl>
-          <dt><code>uuid</code></dt>
-          <dd>The content of the <code>uuid</code> element provides
-            a globally unique identifier for the virtual domain.</dd>
-          <dt><code>name</code></dt>
-          <dd>The unique name of the virtual domain</dd>
-        </dl>
-      </dd>
-      <dt><code>group</code></dt>
-      <dd>The port group in the virtual network to which the
-        port belongs. Can be omitted if no port groups are
-        defined on the network.</dd>
-      <dt><code>mac</code></dt>
-      <dd>The <code>address</code> attribute provides the MAC
-        address of the virtual port that will be see by the
-        guest. The MAC address must not start with 0xFE as this
-        byte is reserved for use on the host side of the port.
-      </dd>
-    </dl>
-
-    <h3><a id="elementsCommon">Common elements</a></h3>
-
-    <p>
-      The following elements are common to one or more of the plug
-      types listed later
-    </p>
-
-    <pre>
-  ...
-  &lt;bandwidth&gt;
-    &lt;inbound average='1000' peak='5000' floor='200' burst='1024'/&gt;
-    &lt;outbound average='128' peak='256' burst='256'/&gt;
-  &lt;/bandwidth&gt;
-  &lt;rxfilters trustGuest='yes'/&gt;
-  &lt;virtualport type='802.1Qbg'&gt;
-    &lt;parameters managerid='11' typeid='1193047' typeidversion='2'/&gt;
-  &lt;/virtualport&gt;
-  ...</pre>
-
-    <dl>
-      <dt><code>bandwidth</code></dt>
-      <dd>This part of the network port XML provides setting quality of service.
-        Incoming and outgoing traffic can be shaped independently.
-        The <code>bandwidth</code> element and its child elements are described
-        in the <a href="formatnetwork.html#elementQoS">QoS</a> section of
-        the Network XML. In addition the <code>classID</code> attribute may
-        exist to provide the ID of the traffic shaping class that is active.
-      </dd>
-      <dt><code>rxfilters</code></dt>
-      <dd>The <code>rxfilters</code> element property
-        <code>trustGuest</code> provides the
-        capability for the host to detect and trust reports from the
-        guest regarding changes to the interface mac address and receive
-        filters by setting the attribute to <code>yes</code>. The default
-        setting for the attribute is <code>no</code> for security
-        reasons and support depends on the guest network device model as
-        well as the type of connection on the host - currently it is
-        only supported for the virtio device model and for macvtap
-        connections on the host.
-      </dd>
-      <dt><code>virtualport</code></dt>
-      <dd>The <code>virtualport</code> element describes metadata that
-        needs to be provided to the underlying network subsystem. It
-        is described in the domain XML
-        <a href="formatdomain.html#elementsNICS">interface documentation</a>.
-      </dd>
-    </dl>
-
-
-    <h3><a id="elementsPlug">Plugs</a></h3>
-
-    <p>
-      The <code>plug</code> element has varying content depending
-      on the value of the <code>type</code> attribute.
-    </p>
-
-    <h4><a id="elementsPlugNetwork">Network</a></h4>
-
-    <p>
-      The <code>network</code> plug type refers to a managed virtual
-      network plug that is based on a traditional software bridge
-      device privately managed by libvirt.
-    </p>
-
-    <pre>
-  ...
-  &lt;plug type='network' bridge='virbr0'/&gt;
-  ...</pre>
-
-    <p>
-      The <code>bridge</code> attribute provides the name of the
-      privately managed bridge device associated with the virtual
-      network.
-    </p>
-
-    <h4><a id="elementsPlugNetwork">Bridge</a></h4>
-
-    <p>
-      The <code>bridge</code> plug type refers to an externally
-      managed traditional software bridge.
-    </p>
-
-    <pre>
-  ...
-  &lt;plug type='bridge' bridge='br2'/&gt;
-  ...</pre>
-
-    <p>
-      The <code>bridge</code> attribute provides the name of the
-      externally managed bridge device associated with the virtual
-      network.
-    </p>
-
-    <h4><a id="elementsPlugNetwork">Direct</a></h4>
-
-    <p>
-      The <code>direct</code> plug type refers to a connection
-      directly to a physical network interface.
-    </p>
-
-    <pre>
-  ...
-  &lt;plug type='direct' dev='ens3' mode='vepa'/&gt;
-  ...</pre>
-
-    <p>
-      The <code>dev</code> attribute provides the name of the
-      physical network interface to which the port will be
-      connected. The <code>mode</code> attribute describes
-      how the connection will be setup and takes the same
-      values described in the
-      <a href="formatdomain.html#elementsNICSDirect">domain XML</a>.
-    </p>
-
-    <h4><a id="elementsPlugNetwork">Host PCI</a></h4>
-
-    <p>
-      The <code>hostdev-pci</code> plug type refers to the
-      passthrough of a physical PCI device rather than emulation.
-    </p>
-
-    <pre>
-  ...
-  &lt;plug type='hostdev-pci' managed='yes'&gt;
-    &lt;driver name='vfio'/&gt;
-    &lt;address domain='0x0001' bus='0x02' slot='0x03' function='0x4'/&gt;
-  &lt;/plug&gt;
-  ...</pre>
-
-    <p>
-      The <code>managed</code> attribute indicates who is responsible for
-      managing the PCI device in the host. When set to the value <code>yes</code>
-      libvirt is responsible for automatically detaching the device from host
-      drivers and resetting it if needed. If the value is <code>no</code>,
-      some other party must ensure the device is not attached to any
-      host drivers.
-    </p>
-
-  </body>
-</html>

docs/formatnode.html.in

@@ -70,10 +70,6 @@
           <dd>Describes a device on the host's PCI bus.  Sub-elements
             include:
             <dl>
-              <dt><code>class</code></dt>
-              <dd>Optional element for combined class, subclass and
-                programming interface codes as 6-digit hexadecimal number.
-                <span class="since">Since 5.2.0</span></dd>
               <dt><code>domain</code></dt>
               <dd>Which domain the device belongs to.</dd>
               <dt><code>bus</code></dt>
@@ -385,7 +381,6 @@
     &lt;name&gt;igb&lt;/name&gt;
   &lt;/driver&gt;
   &lt;capability type='pci'&gt;
-    &lt;class&gt;0x020000&lt;/class&gt;
     &lt;domain&gt;0&lt;/domain&gt;
     &lt;bus&gt;2&lt;/bus&gt;
     &lt;slot&gt;0&lt;/slot&gt;

docs/formatsecret.html.in

@@ -42,8 +42,8 @@
         Specifies what this secret is used for.  A mandatory
         <code>type</code> attribute specifies the usage category, currently
         only <code>volume</code>, <code>ceph</code>, <code>iscsi</code>,
-        <code>tls</code>, and <code>vtpm</code> are defined. Specific usage
-        categories are described below.
+        and <code>tls</code> are defined. Specific usage categories
+        are described below.
       </dd>
     </dl>
 
@@ -322,63 +322,6 @@ Secret 718c71bd-67b5-4a2b-87ec-a24e8ca200dc created
     <pre>
 # MYSECRET=`printf %s "letmein" | base64`
 # virsh secret-set-value 718c71bd-67b5-4a2b-87ec-a24e8ca200dc $MYSECRET
-Secret value set
-
-    </pre>
-
-    <h3><a id="vTPMUsageType">Usage type "vtpm"</a></h3>
-
-    <p>
-      This secret is associated with a virtualized TPM (vTPM) and serves
-      as a passphrase for deriving a key from for encrypting the state
-      of the vTPM.
-      The <code>&lt;usage type='vtpm'&gt;</code> element must contain
-      a single <code>name</code> element that specifies a usage name
-      for the secret.  The vTPM secret can then be used by UUID
-      via the <code>&lt;encryption&gt;</code> element of
-      a <a href="formatdomain.html#elementsTpm">tpm</a> when using an
-      emulator.
-      <span class="since">Since 5.6.0</span>. The following is an example
-      of the steps to be taken.  First create a vtpm-secret.xml file:    </p>
-
-    <pre>
-# cat vtpm-secret.xml
-&lt;secret ephemeral='no' private='yes'&gt;
-   &lt;description&gt;sample vTPM secret&lt;/description&gt;
-   &lt;usage type='vtpm'&gt;
-      &lt;name&gt;VTPM_example&lt;/name&gt;
-   &lt;/usage&gt;
-&lt;/secret&gt;
-
-# virsh secret-define vtpm-secret.xml
-Secret 6dd3e4a5-1d76-44ce-961f-f119f5aad935 created
-
-# virsh secret-list
- UUID                                   Usage
-----------------------------------------------------------------------------------------
- 6dd3e4a5-1d76-44ce-961f-f119f5aad935   vtpm VTPM_example
-
-#
-
-    </pre>
-
-    <p>
-      A secret may also be defined via the
-      <a href="html/libvirt-libvirt-secret.html#virSecretDefineXML">
-       <code>virSecretDefineXML</code></a> API.
-
-      Once the secret is defined, a secret value will need to be set. The
-      secret would be the passphrase used to decrypt the vTPM state.
-      The following is a simple example of using
-      <code>virsh secret-set-value</code> to set the secret value. The
-      <a href="html/libvirt-libvirt-secret.html#virSecretSetValue">
-      <code>virSecretSetValue</code></a> API may also be used to set
-      a more secure secret without using printable/readable characters.
-    </p>
-
-    <pre>
-# MYSECRET=`printf %s "open sesame" | base64`
-# virsh secret-set-value 6dd3e4a5-1d76-44ce-961f-f119f5aad935 $MYSECRET
 Secret value set
 
     </pre>

docs/formatsnapshot.html.in

@@ -9,9 +9,7 @@
     <h2><a id="SnapshotAttributes">Snapshot XML</a></h2>
 
     <p>
-      Snapshots are one form
-      of <a href="kbase/domainstatecapture.html">domain state
-      capture</a>.  There are several types of snapshots:
+      There are several types of snapshots:
     </p>
     <dl>
       <dt>disk snapshot</dt>
@@ -35,7 +33,7 @@
         resume in a consistent state; but if the disks are modified
         externally in the meantime, this is likely to lead to data
         corruption.</dd>
-      <dt>full system</dt>
+      <dt>system checkpoint</dt>
       <dd>A combination of disk snapshots for all disks as well as VM
         memory state, which can be used to resume the guest from where it
         left off with symptoms similar to hibernation (that is, TCP
@@ -57,12 +55,11 @@
       as <code>virDomainSaveImageGetXMLDesc()</code> to work with
       those files.
     </p>
-    <p>Full system snapshots are created
-      by <code>virDomainSnapshotCreateXML()</code> with no flags, while
+    <p>System checkpoints are created
+      by <code>virDomainSnapshotCreateXML()</code> with no flags, and
       disk snapshots are created by the same function with
-      the <code>VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY</code>
-      flag. Regardless of the flags provided, restoration of the
-      snapshot is handled by
+      the <code>VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY</code> flag; in
+      both cases, they are restored by
       the <code>virDomainRevertToSnapshot()</code> function.  For
       these types of snapshots, libvirt tracks each snapshot as a
       separate <code>virDomainSnapshotPtr</code> object, and maintains
@@ -81,8 +78,7 @@
       redefining a snapshot (<span class="since">since 0.9.5</span>),
       with the <code>VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE</code> flag
       of <code>virDomainSnapshotCreateXML()</code>, all of the XML
-      described here is relevant on input, even the fields that are
-      normally described as readonly for output.
+      described here is relevant.
     </p>
     <p>
       Snapshots are maintained in a hierarchy.  A domain can have a
@@ -93,9 +89,7 @@
       sets that snapshot as current, and the prior current snapshot is
       the parent of the new snapshot.  Branches in the hierarchy can
       be formed by reverting to a snapshot with a child, then creating
-      another snapshot.  For now, the creation of external snapshots
-      when checkpoints exist is forbidden, although future work will
-      make it possible to integrate these two concepts.
+      another snapshot.
     </p>
     <p>
       The top-level <code>domainsnapshot</code> element may contain
@@ -103,14 +97,16 @@
     </p>
     <dl>
       <dt><code>name</code></dt>
-      <dd>The optional name for this snapshot.  If the name is
-        omitted, libvirt will create a name based on the time of the
-        creation.
+      <dd>The name for this snapshot.  If the name is specified when
+        initially creating the snapshot, then the snapshot will have
+        that particular name.  If the name is omitted when initially
+        creating the snapshot, then libvirt will make up a name for
+        the snapshot, based on the time when it was created.
       </dd>
       <dt><code>description</code></dt>
-      <dd>An optional human-readable description of the snapshot.  If
-        the description is omitted when initially creating the
-        snapshot, then this field will be empty.
+      <dd>A human-readable description of the snapshot.  If the
+        description is omitted when initially creating the snapshot,
+        then this field will be empty.
       </dd>
       <dt><code>memory</code></dt>
       <dd>On input, this is an optional request for how to handle VM
@@ -132,10 +128,13 @@
         what file name is created in an external snapshot.  On output,
         this is fully populated to show the state of each disk in the
         snapshot, including any properties that were generated by the
-        hypervisor defaults.  For full system snapshots, this field is
-        ignored on input and omitted on output (a full system snapshot
-        implies that all disks participate in the snapshot process).
-        This element has a list of <code>disk</code>
+        hypervisor defaults.  For system checkpoints, this field is
+        ignored on input and omitted on output (a system checkpoint
+        implies that all disks participate in the snapshot process,
+        and since the current implementation only does internal system
+        checkpoints, there are no extra details to add); a future
+        release may allow the use of <code>disks</code> with a system
+        checkpoint.  This element has a list of <code>disk</code>
         sub-elements, describing anywhere from zero to all of the
         disks associated with the domain.  <span class="since">Since
         0.9.5</span>
@@ -144,8 +143,8 @@
           <dd>This sub-element describes the snapshot properties of a
             specific disk.  The attribute <code>name</code> is
             mandatory, and must match either the <code>&lt;target
-            dev='name'/&gt;</code> (recommended) or an unambiguous
-            <code>&lt;source file='name'/&gt;</code> of one of
+            dev='name'/&gt;</code> or an unambiguous <code>&lt;source
+            file='name'/&gt;</code> of one of
             the <a href="formatdomain.html#elementsDisks">disk
             devices</a> specified for the domain at the time of the
             snapshot.  The attribute <code>snapshot</code> is
@@ -174,12 +173,6 @@
               snapshots, the original file name becomes the read-only
               snapshot, and the new file name contains the read-write
               delta of all disk changes since the snapshot.
-              <p/>
-              The <code>source</code> element also may contain the
-              <code>seclabel</code> element (described in the
-              <a href="formatdomain.html#seclabel">domain XML documentation</a>)
-              which can be used to override the domain security labeling policy
-              for <code>source</code>.
               </dd>
               <dt><code>driver</code></dt>
               <dd>An optional sub-element <code>driver</code>,
@@ -187,7 +180,6 @@
               as qcow2), of the new file created by the external
               snapshot of the new file.
               </dd>
-              <dt><code>seclabel</code></dt>
             </dl>
 
             <span class="since">Since 1.2.2</span> the <code>disk</code> element
@@ -209,50 +201,45 @@
         </dl>
       </dd>
       <dt><code>creationTime</code></dt>
-      <dd>A readonly representation of the time this snapshot was
-        created.  The time is specified in seconds since the Epoch,
-        UTC (i.e. Unix time).
+      <dd>The time this snapshot was created.  The time is specified
+        in seconds since the Epoch, UTC (i.e. Unix time).  Readonly.
       </dd>
       <dt><code>state</code></dt>
-      <dd>A readonly representation of the state of the domain at the
-        time this snapshot was taken.  If a full system snapshot was
-        created, then this is the state of the domain at that
-        time. When the domain is reverted to this snapshot, the
-        domain's state will default to this state, unless overridden
-        by <code>virDomainRevertToSnapshot()</code> flags to revert to
-        a running or paused state. Additionally, this field can be the
-        value "disk-snapshot" (<span class="since">since 0.9.5</span>)
-        when it represents only a disk snapshot (no VM memory state),
-        and reverting to this snapshot will default to an inactive
-        guest.
+      <dd>The state of the domain at the time this snapshot was taken.
+        If the snapshot was created as a system checkpoint, then this
+        is the state of the domain at that time; when the domain is
+        reverted to this snapshot, the domain's state will default to
+        whatever is in this field unless additional flags are passed
+        to <code>virDomainRevertToSnapshot()</code>.  Additionally,
+        this field can be the value "disk-snapshot"
+        (<span class="since">since 0.9.5</span>) when it represents
+        only a disk snapshot (no VM memory state), and reverting to this
+        snapshot will default to an inactive guest.  Readonly.
       </dd>
       <dt><code>parent</code></dt>
-      <dd>Readonly, present only if this snapshot has a parent. The
-        parent name is given by the sub-element <code>name</code>. The
-        parent relationship allows tracking a tree of related snapshots.
+      <dd>The parent of this snapshot.  If present, this element
+        contains exactly one child element, name.  This specifies the
+        name of the parent snapshot of this snapshot, and is used to
+        represent trees of snapshots.  Readonly.
       </dd>
       <dt><code>domain</code></dt>
-      <dd>A readonly representation of the domain that this snapshot
-        was taken against.  Older versions of libvirt stored only a
-        single child element, uuid; reverting to a snapshot like this
-        is risky if the current state of the domain differs from the
-        state that the domain was created in, and requires the use of
-        the <code>VIR_DOMAIN_SNAPSHOT_REVERT_FORCE</code> flag
+      <dd>The domain that this snapshot was taken against.  Older
+        versions of libvirt stored only a single child element, uuid;
+        reverting to a snapshot like this is risky if the current
+        state of the domain differs from the state that the domain was
+        created in, and requires the use of the
+        <code>VIR_DOMAIN_SNAPSHOT_REVERT_FORCE</code> flag
         in <code>virDomainRevertToSnapshot()</code>.  Newer versions
-        of libvirt (<span class="since">since 0.9.5</span>) store the
-        entire inactive <a href="formatdomain.html">domain
-        configuration</a> at the time of the snapshot
-        (<span class="since">since 0.9.5</span>). The domain will have
-        security-sensitive information omitted
-        unless the flag <code>VIR_DOMAIN_SNAPSHOT_XML_SECURE</code> is
-        provided on a read-write connection.
+        of libvirt (<span class="since">since 0.9.5</span>) store the entire
+        inactive <a href="formatdomain.html">domain configuration</a>
+        at the time of the snapshot (<span class="since">since
+        0.9.5</span>).  Readonly.
       </dd>
       <dt><code>cookie</code></dt>
-      <dd>An optional readonly representation of a save image cookie
-        containing additional data libvirt may need to properly
-        restore a domain from an active snapshot when such data cannot
-        be stored directly in the <code>domain</code> to maintain
-        compatibility with older libvirt or hypervisor.
+      <dd>Save image cookie containing additional data libvirt may need to
+        properly restore a domain from an active snapshot when such data
+        cannot be stored directly in the <code>domain</code> to maintain
+        compatibility with older libvirt or hypervisor. Readonly.
       </dd>
     </dl>
 
@@ -264,15 +251,10 @@
 &lt;domainsnapshot&gt;
   &lt;description&gt;Snapshot of OS install and updates&lt;/description&gt;
   &lt;disks&gt;
-    &lt;disk name='vda'&gt;
+    &lt;disk name='/path/to/old'&gt;
       &lt;source file='/path/to/new'/&gt;
     &lt;/disk&gt;
     &lt;disk name='vdb' snapshot='no'/&gt;
-    &lt;disk name='vdc'&gt;
-      &lt;source file='/path/to/newc'&gt;
-        &lt;seclabel model='dac' relabel='no'/&gt;
-      &lt;/source&gt;
-    &lt;/disk&gt;
   &lt;/disks&gt;
 &lt;/domainsnapshot&gt;</pre>
 

docs/formatstorage.html.in

@@ -19,15 +19,14 @@
       a single attribute <code>type</code>, which is one of <code>dir</code>,
       <code>fs</code>, <code>netfs</code>, <code>disk</code>,
       <code>iscsi</code>, <code>logical</code>, <code>scsi</code>
-      (all <span class="since">since 0.4.1</span>),
-      <code>mpath</code> (<span class="since">since 0.7.1</span>),
-      <code>rbd</code> (<span class="since">since 0.9.13</span>),
-      <code>sheepdog</code> (<span class="since">since 0.10.0</span>),
-      <code>gluster</code> (<span class="since">since 1.2.0</span>),
-      <code>zfs</code> (<span class="since">since 1.2.8</span>),
-      <code>vstorage</code> (<span class="since">since 3.1.0</span>),
-      or <code>iscsi-direct</code> (<span class="since">since 4.7.0</span>).
-      This corresponds to the
+      (all <span class="since">since 0.4.1</span>), <code>mpath</code>
+      (<span class="since">since 0.7.1</span>), <code>rbd</code>
+      (<span class="since">since 0.9.13</span>), <code>sheepdog</code>
+      (<span class="since">since 0.10.0</span>),
+      <code>gluster</code> (<span class="since">since
+      1.2.0</span>),  <code>zfs</code> (<span class="since">since
+      1.2.8</span>) or <code>vstorage</code> (<span class="since">since
+      3.1.0</span>). This corresponds to the
       storage backend drivers listed further along in this document.
     </p>
     <h3><a id="StoragePoolFirst">General metadata</a></h3>
@@ -122,26 +121,15 @@
 &lt;/source&gt;
 ...</pre>
 
-    <pre>
-...
-  &lt;source&gt;
-    &lt;host name='localhost'/&gt;
-    &lt;dir path='/var/lib/libvirt/images'/&gt;
-    &lt;format type='nfs'/&gt;
-    &lt;protocol ver='3'/&gt;
-  &lt;/source&gt;
-...</pre>
-
     <dl>
       <dt><code>device</code></dt>
       <dd>Provides the source for pools backed by physical devices
         (pool types <code>fs</code>, <code>logical</code>, <code>disk</code>,
-        <code>iscsi</code>, <code>iscsi-direct</code>, <code>zfs</code>,
-        <code>vstorage</code>).
+        <code>iscsi</code>, <code>zfs</code>, <code>vstorage</code>).
         May be repeated multiple times depending on backend driver. Contains
         a required attribute <code>path</code> which is either the fully
         qualified path to the block device node or for <code>iscsi</code>
-        or <code>iscsi-direct</code> the iSCSI Qualified Name (IQN).
+        the iSCSI Qualified Name (IQN).
         <span class="since">Since 0.4.1</span>
         <p>An optional attribute <code>part_separator</code> for each
         <code>path</code> may be supplied. Valid values for the attribute
@@ -346,7 +334,6 @@
       <dt><code>host</code></dt>
       <dd>Provides the source for pools backed by storage from a
         remote server (pool types <code>netfs</code>, <code>iscsi</code>,
-        <code>iscsi-direct</code>,
         <code>rbd</code>, <code>sheepdog</code>, <code>gluster</code>). Will be
         used in combination with a <code>directory</code>
         or <code>device</code> element. Contains an attribute <code>name</code>
@@ -361,19 +348,11 @@
         server. See the <a href="storage.html">storage driver page</a> for
         any restrictions for specific storage backends.
         <span class="since">Since 0.4.1</span></dd>
-      <dt><code>initiator</code></dt>
-      <dd>Required by the <code>iscsi-direct</code> pool in order to provide
-        the iSCSI Qualified Name (IQN) to communicate with the pool's
-        <code>device</code> target IQN. There is one sub-element
-        <code>iqn</code> with the <code>name</code> attribute to describe
-        the IQN for the initiator.
-        <span class="since">Since 4.7.0</span></dd>
       <dt><code>auth</code></dt>
       <dd>If present, the <code>auth</code> element provides the
         authentication credentials needed to access the source by the
         setting of the <code>type</code> attribute (pool
-        types <code>iscsi</code>, <code>iscsi-direct</code>, <code>rbd</code>).
-        The <code>type</code>
+        types <code>iscsi</code>, <code>rbd</code>). The <code>type</code>
         must be either "chap" or "ceph". Use "ceph" for
         Ceph RBD (Rados Block Device) network sources and use "iscsi" for CHAP
         (Challenge-Handshake Authentication Protocol) iSCSI
@@ -407,12 +386,6 @@
         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>protocol</code></dt>
-      <dd>For a <code>netfs</code> Storage Pool provide a mechanism to
-        define which NFS protocol version number will be used to contact
-        the server's NFS service. The attribute <code>ver</code> accepts
-        an unsigned integer as the version number to use.
-        <span class="since">Since 5.1.0</span></dd>
       <dt><code>vendor</code></dt>
       <dd>Provides optional information about the vendor of the
         storage device. This contains a single
@@ -478,8 +451,8 @@
         The <code>owner</code> element contains the numeric user ID.
         The <code>group</code> element contains the numeric group ID.
         If <code>owner</code> or <code>group</code> aren't specified when
-        creating a directory, the UID and GID of the libvirtd process are used.
-        The <code>label</code> element contains the MAC (eg SELinux)
+        creating a directory, the values are inherited from the parent
+        directory. The <code>label</code> element contains the MAC (eg SELinux)
         label string.
         <span class="since">Since 0.4.1</span>
         For running directory or filesystem based pools, these fields
@@ -508,145 +481,6 @@
       device, measured in bytes.  <span class="since">Since 0.4.1</span>
     </p>
 
-    <h3><a id="StoragePoolRefresh">Refresh overrides</a></h3>
-
-    <p>
-      The optional <code>refresh</code> element can control how the pool and
-      associated volumes are refreshed (pool type <code>rbd</code>). The
-      <code>allocation</code> attribute of the <code>volume</code> child element
-      controls the method used for computing the allocation of a volume. The
-      valid attribute values are <code>default</code> to compute the actual
-      usage or <code>capacity</code> to use the logical capacity for cases where
-      computing the allocation is too expensive. The following XML snippet
-      shows the syntax:
-      <pre>
-&lt;pool type="rbd"&gt;
-  &lt;name&gt;myrbdpool&lt;/name&gt;
-...
-  &lt;source/&gt;
-...
-  &lt;refresh&gt;
-    &lt;volume allocation='capacity'/&gt;
-  &lt;/refresh&gt;
-...
-&lt;/pool&gt;
-</pre>
-      <span class="since">Since 5.2.0</span>
-    </p>
-
-    <h3><a id="StoragePoolNamespaces">Storage Pool Namespaces</a></h3>
-
-    <p>
-      Usage of Storage Pool Namespaces provides a mechanism to provide
-      pool type specific data in a free form or arbitrary manner via
-      XML syntax targeted solely for the needs of the specific pool type
-      which is not otherwise supported in standard XML. For the "fs" and
-      "netfs" pool types this provides a mechanism to provide additional
-      mount options on the command line. For the "rbd" pool this provides
-      a mechanism to override default settings for RBD configuration options.
-    </p>
-    <p>
-      Usage of namespaces comes with no support guarantees. It is intended
-      for developers testing out a concept prior to requesting an explicitly
-      supported XML option in libvirt, and thus should never be used in
-      production.
-    </p>
-    <dl>
-      <dt><code>fs:mount_opts</code></dt>
-      <dd>Provides an XML namespace mechanism to optionally utilize
-        specifically named options for the mount command via the "-o"
-        option for the <code>fs</code> or <code>netfs</code> type storage
-        pools. In order to designate that the Storage Pool will be using
-        the mechanism, the <code>pool</code> element must be modified to
-        provide the XML namespace attribute syntax as follows:
-
-        <p>
-        xmlns:fs='http://libvirt.org/schemas/storagepool/fs/1.0'
-        </p>
-
-        <p>
-        The <code>fs:mount_opts</code> defines the mount options by
-        specifying multiple <code>fs:option</code> subelements with
-        the attribute <code>name</code> specifying the mount option to
-        be added. The value of the named option is not checked since
-        it's possible options don't exist on all distributions. It is
-        expected that proper and valid options will be supplied for the
-        target host.
-        </p>
-
-        The following XML snippet shows the syntax required in order to
-        utilize for a netfs pool:
-      <pre>
-&lt;pool type="netfs" xmlns:fs='http://libvirt.org/schemas/storagepool/fs/1.0'&gt;
-  &lt;name&gt;nfsimages&lt;/name&gt;
-...
-  &lt;source&gt;
-...
-  &lt;/source&gt;
-...
-  &lt;target&gt;
-...
-  &lt;/target&gt;
-  &lt;fs:mount_opts&gt;
-    &lt;fs:option name='sync'/&gt;
-    &lt;fs:option name='lazytime'/&gt;
-  &lt;/fs:mount_opts&gt;
-&lt;/pool&gt;
-...</pre>
-
-      <span class="since">Since 5.1.0.</span></dd>
-
-      <dt><code>rbd:config_opts</code></dt>
-      <dd>Provides an XML namespace mechanism to optionally utilize
-        specifically named options for the RBD configuration options
-        via the rados_conf_set API for the <code>rbd</code> type
-        storage pools. In order to designate that the Storage Pool
-        will be using the mechanism, the <code>pool</code> element
-        must be modified to provide the XML namespace attribute
-        syntax as follows:
-
-        <p>
-        xmlns:rbd='http://libvirt.org/schemas/storagepool/rbd/1.0'
-        </p>
-
-        <p>
-        The <code>rbd:config_opts</code> defines the configuration options
-        by specifying multiple <code>rbd:option</code> subelements with
-        the attribute <code>name</code> specifying the configuration option
-        to be added and <code>value</code> specifying the configuration
-        option value. The name and value for each option is only checked
-        to be not empty. The name and value provided are not checked since
-        it's possible options don't exist on all distributions. It is
-        expected that proper and valid options will be supplied for the
-        target host.
-        </p>
-
-        The following XML snippet shows the syntax required in order to
-        utilize
-      <pre>
-&lt;pool type="rbd" xmlns:rbd='http://libvirt.org/schemas/storagepool/rbd/1.0'&gt;
-  &lt;name&gt;myrbdpool&lt;/name&gt;
-...
-  &lt;source&gt;
-...
-  &lt;/source&gt;
-...
-  &lt;target&gt;
-...
-  &lt;/target&gt;
-...
-  &lt;rbd:config_opts&gt;
-    &lt;rbd:option name='client_mount_timeout' value='45'/&gt;
-    &lt;rbd:option name='rados_mon_op_timeout' value='20'/&gt;
-    &lt;rbd:option name='rados_osd_op_timeout' value='10'/&gt;
-  &lt;/rbd:config_opts&gt;
-&lt;/pool&gt;
-</pre>
-
-      <span class="since">Since 5.1.0.</span></dd>
-
-    </dl>
-
     <h2><a id="StorageVol">Storage volume XML</a></h2>
     <p>
       A storage volume will generally be either a file or a device
@@ -802,8 +636,8 @@
         The <code>owner</code> element contains the numeric user ID.
         The <code>group</code> element contains the numeric group ID.
         If <code>owner</code> or <code>group</code> aren't specified when
-        creating a supported volume, the UID and GID of the libvirtd process
-        are used. The <code>label</code> element contains the MAC (eg SELinux)
+        creating a supported volume, the values are inherited from the parent
+        directory. The <code>label</code> element contains the MAC (eg SELinux)
         label string.
         For existing directory or filesystem based volumes, these fields
         will be filled with the values used by the existing file.

docs/formatstoragecaps.html.in

@@ -1,101 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body>
-    <h1>Storage Pool Capabilities XML format</h1>
-
-    <ul id="toc"></ul>
-
-    <h2><a id="Overview">Overview</a></h2>
-
-    <p>The Storage Pool Capabilities XML will provide the information
-    to determine what types of Storage Pools exist, whether the pool is
-    supported, and if relevant the source format types, the required
-    source elements, and the target volume format types. </p>
-
-    <p>The Storage Pool Capabilities XML provides more information than the
-      <a href="/html/libvirt-libvirt-host.html#virConnectGetCapabilities">
-        <code>virConnectGetCapabilities</code>
-      </a>
-    which only provides an enumerated list of supported pool types.</p>
-
-    <h2><a id="elements">Element and attribute overview</a></h2>
-
-    <p>A query interface was added to the virConnect API's to retrieve the
-    XML listing of the set of Storage Pool Capabilities
-    (<span class="since">Since 5.2.0</span>):</p>
-
-<pre>
-<a href="/html/libvirt-libvirt-domain.html#virConnectGetStoragePoolCapabilities">virConnectGetStoragePoolCapabilities</a>
-</pre>
-
-    <p>The root element that emulator capability XML document starts with is
-    named <code>storagepoolCapabilities</code>. There will be any number of
-    <code>pool</code> child elements with two attributes <code>type</code>
-    and <code>supported</code>. Each <code>pool</code> element may have
-    a <code>poolOptions</code> or <code>volOptions</code> subelements to
-    describe the available features. Sample XML output is:</p>
-
-<pre>
-&lt;storagepoolCapabilities&gt;
-  &lt;pool type='dir' supported='yes'&gt;
-    &lt;volOptions&gt;
-      &lt;defaultFormat type='raw'&lt;/&gt;
-      &lt;enum name='targetFormatType'&gt;
-        &lt;value&gt;none&lt;/value&gt;
-        &lt;value&gt;raw&lt;/value&gt;
-        ...
-      &lt;/enum&gt;
-    &lt;/volOptions&gt;
-  &lt;/pool&gt;
-  &lt;pool type='fs' supported='yes'&gt;
-    &lt;poolOptions&gt;
-      &lt;defaultFormat type='auto'&lt;/&gt;
-      &lt;enum name='sourceFormatType'&gt;
-        &lt;value&gt;auto&lt;/value&gt;
-        &lt;value&gt;ext2&lt;/value&gt;
-        ...
-      &lt;/enum&gt;
-    &lt;/poolOptions&gt;
-    &lt;volOptions&gt;
-      &lt;defaultFormat type='raw'&lt;/&gt;
-      &lt;enum name='targetFormatType'&gt;
-        &lt;value&gt;none&lt;/value&gt;
-        &lt;value&gt;raw&lt;/value&gt;
-        ...
-      &lt;/enum&gt;
-    &lt;/volOptions&gt;
-  &lt;/pool&gt;
-  ...
-&lt;/storagepoolCapabilities&gt;
-</pre>
-
-    <p>The following section decribes subelements of the
-    <code>poolOptions</code> and <code>volOptions</code> subelements </p>:
-
-    <dl>
-      <dt><code>defaultFormat</code></dt>
-      <dd>For the <code>poolOptions</code>, the <code>type</code> attribute
-      describes the default format name used for the pool source. For the
-      <code>volOptions</code>, the <code>type</code> attribute describes
-      the default volume name used for each volume.
-      </dd>
-      <dl>
-        <dt><code>enum</code></dt>
-        <dd>Each enum uses a name from the list below with any number of
-        <code>value</code> value subelements describing the valid values.
-          <dl>
-            <dt><code>sourceFormatType</code></dt>
-            <dd>Lists all the possible <code>poolOptions</code> source
-            pool format types.
-            </dd>
-            <dt><code>targetFormatType</code></dt>
-            <dd>Lists all the possible <code>volOptions</code> target volume
-            format types.
-            </dd>
-          </dl>
-        </dd>
-      </dl>
-    </dl>
-  </body>
-</html>

docs/genaclperms.pl

@@ -0,0 +1,124 @@
+#!/usr/bin/env perl
+#
+# Copyright (C) 2013 Red Hat, Inc.
+#
+# 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/>.
+#
+
+use strict;
+use warnings;
+
+my @objects = (
+    "CONNECT", "DOMAIN", "INTERFACE",
+    "NETWORK","NODE_DEVICE", "NWFILTER",
+     "SECRET", "STORAGE_POOL", "STORAGE_VOL",
+    );
+
+my %class;
+
+foreach my $object (@objects) {
+    my $class = lc $object;
+
+    $class =~ s/(^\w|_\w)/uc $1/eg;
+    $class =~ s/_//g;
+    $class =~ s/Nwfilter/NWFilter/;
+    $class = "vir" . $class . "Ptr";
+
+    $class{$object} = $class;
+}
+
+my $objects = join ("|", @objects);
+
+my %opts;
+my $in_opts = 0;
+
+my %perms;
+
+while (<>) {
+    if ($in_opts) {
+        if (m,\*/,) {
+            $in_opts = 0;
+        } elsif (/\*\s*\@(\w+):\s*(.*?)\s*$/) {
+            $opts{$1} = $2;
+        }
+    } elsif (m,/\*\*,) {
+        $in_opts = 1;
+    } elsif (/VIR_ACCESS_PERM_($objects)_((?:\w|_)+),/) {
+        my $object = $1;
+        my $perm = lc $2;
+        next if $perm eq "last";
+
+        $perm =~ s/_/-/g;
+
+        $perms{$object} = {} unless exists $perms{$object};
+        $perms{$object}->{$perm} = {
+            desc => $opts{desc},
+            message => $opts{message},
+            anonymous => $opts{anonymous}
+        };
+        %opts = ();
+    }
+}
+
+print <<EOF;
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body>
+EOF
+
+foreach my $object (sort { $a cmp $b } keys %perms) {
+    my $class = $class{$object};
+    my $olink = lc "object_" . $object;
+    print <<EOF;
+<h3><a name="$olink">$class</a></h3>
+<table class="acl">
+  <thead>
+    <tr>
+      <th>Permission</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+EOF
+
+    foreach my $perm (sort { $a cmp $b } keys %{$perms{$object}}) {
+        my $description = $perms{$object}->{$perm}->{desc};
+
+        die "missing description for $object.$perm" unless
+            defined $description;
+
+        my $plink = lc "perm_" . $object . "_" . $perm;
+        $plink =~ s/-/_/g;
+
+        print <<EOF;
+    <tr>
+      <td><a name="$plink">$perm</a></td>
+      <td>$description</td>
+    </tr>
+EOF
+
+    }
+
+    print <<EOF;
+  </tbody>
+</table>
+EOF
+}
+
+print <<EOF;
+  </body>
+</html>
+EOF

docs/generic.css

@@ -72,11 +72,11 @@ h6 {
   font-size: 0.8em;
 }
 
-code, pre, tt {
+code, pre {
   font-family: LibvirtOverpassMono;
 }
 
-dd code, p code, tt {
+dd code, p code {
   background-color: #eeeeee;
 }
 

docs/gitdm/aliases

@@ -1,25 +0,0 @@
-# Silly mistakes, mostly found in S-o-b or R-b tags.
-
-"jdenemar redhat com" jdenemar@redhat.com
-"pkrempa@redhat st.com" pkrempa@redhat.com
-jyang@redhat jyang@redhat.com
-wangjie88.huawei.com wangjie88@huawei.com
-
-# This is information that's already present in .mailmap, and having to
-# duplicate it is annoying. Unfortunately gitdm doesn't parse .mailmap
-# and the format is different, so we can't just point it to the file
-# either.
-
-cedric.bosdonnat@free.fr cbosdonnat@suse.com
-dan@berrange.com berrange@redhat.com
-fabiano@fidencio.org fidencio@redhat.com
-intrigeri+libvirt@boum.org intrigeri@boum.org
-jim@meyering.net meyering@redhat.com
-laine@laine.org laine@redhat.com
-redhat@adrb.pl adrian.brzezinski@eo.pl
-shilei.massclouds@gmx.com shi_lei@massclouds.com
-
-# This deviates from what's found in .mailmap, but it makes more sense as
-# far as gitdm is concerned since Jim was employed by Novell at the time.
-
-jfehlig@linux-ypgk.site jfehlig@novell.com

docs/gitdm/companies/canonical

@@ -1,11 +0,0 @@
-canonical.com
-
-# Having an @ubuntu.com email address doesn't necessarily imply you're
-# a Canonical employee; these people, however, seem to have been employed
-# by Canonical at the time they contributed to libvirt.
-
-jamie@ubuntu.com
-serge.hallyn@ubuntu.com
-smoser@ubuntu.com
-soren@ubuntu.com
-wgrant@ubuntu.com

docs/gitdm/companies/datto

@@ -1,2 +0,0 @@
-datto.com
-dattobackup.com

docs/gitdm/companies/dreamhost

@@ -1,4 +0,0 @@
-dreamhost.com
-dreamhost.net
-newdream.com
-newdream.net

docs/gitdm/companies/ibm

@@ -1,7 +0,0 @@
-ibm.com
-
-# These IBM employees used their personal email address when contributing
-# to libvirt and we don't have the corresponding @ibm.com address on file.
-
-danielhb413@gmail.com
-jcfaracco@gmail.com

docs/gitdm/companies/nec

@@ -1,2 +0,0 @@
-nec.co.jp
-nec.com

docs/gitdm/companies/others

@@ -1,102 +0,0 @@
-6wind.com 6WIND
-active.by ActiveCloud
-aero.org Aerospace
-akamai.com Akamai
-amd.com AMD
-anchor.net.au Anchor
-aristanetworks.com Arista Networks
-arpnetworks.com ARP Networks
-av-test.de AV-TEST
-b1-systems.de B1 Systems
-baidu.com Baidu
-brightbox.co.uk Brightbox
-cisco.com Cisco
-citrix.com Citrix
-cloudwatt.com Cloudwatt
-codethink.co.uk Codethink
-cumulusnetworks.com Cumulus Networks
-dataductus.se Data Ductus
-datagravity.com DataGravity
-dell.com Dell
-designassembly.de Coffee-Break-Games
-diateam.net DIATEAM
-eldorado.org.br ELDORADO
-endocode.com Endocode
-eo.pl eo Networks
-ericsson.com Ericsson
-fb.com Facebook
-firewall-services.com Firewall-Services
-freescale.com Freescale
-fujitsu.com Fujitsu
-gluster.com Gluster
-gridcentric.ca Gridcentric
-h3c.com H3C
-hde.co.jp HDE
-hds.com Hitachi Data Systems
-hitachi.com Hitachi
-hoster-ok.com hoster-ok.com
-hp.com HP
-huawei.com Huawei
-inktank.com Inktank Storage
-intel.com Intel
-intellilink.co.jp NTT DATA INTELLILINK
-invisiblethingslab.com Invisible Things Lab
-jtan.com JTAN
-juniper.net Juniper Networks
-laposte.net La Poste
-le.com Le.com
-linaro.org Linaro
-linutronix.de Linutronix
-linux2go.dk Linux2Go
-liquidweb.com Liquid Web
-massclouds.com MassClouds
-mellanox.com Mellanox
-midokura.com Midokura
-mirantis.com Mirantis
-munzinger.de Munzinger Archiv
-netease.com NetEase
-netzquadrat.de [netzquadrat]
-nicira.com Nicira
-nimboxx.com NIMBOXX
-novell.com Novell
-ntt.co.jp NTT Group
-ohmu.fi OHMU
-open-minds.org OpenThink
-oracle.com Oracle
-os-t.de OpenSource Training
-otb.bg Open Technologies Bulgaria
-outscale.com OUTSCALE
-parallels.com Parallels
-petalogix.com PetaLogix
-quobyte.com Quobyte
-ravellosystems.com Ravello Systems
-samsung.com Samsung
-sde.cz SDE
-semihalf.com Semihalf
-siemens.com Siemens
-smartjog.com SmartJog
-solarflare.com Solarflare
-ssatr.ch Swiss Satellite Radio
-sun.com Sun Microsystems
-tabit.pro Tabit
-taobao.com Taobao
-tdf.fr TDF
-tencent.com Tencent
-transip.nl TransIP
-tresys.com Tresys
-uniudc.com Tsinghua Uniudc
-univention.de Univention
-veritas.com Veritas
-vhgroup.net VHGroup
-virtualopensystems.com Virtual Open Systems
-websense.com Websense
-wiktel.com Wikstrom Telephone Company
-windriver.com Wind River
-winhong.com Winhong
-xmission.com XMission
-xs4all.nl XS4ALL
-yadro.com YADRO
-yandex.ru Yandex
-yunify.com Yunify
-zstack.io ZStack
-zte.com.cn ZTE

docs/gitdm/companies/redhat

@@ -1,6 +0,0 @@
-redhat.com
-
-# These Red Hat employees used their personal email address when contributing
-# to libvirt and we don't have the corresponding @redhat.com address on file.
-
-lkundrak@v3.sk

docs/gitdm/companies/suse

@@ -1,7 +0,0 @@
-suse.com
-suse.de
-
-# These SUSE employees used their personal email address when contributing
-# to libvirt and we don't have the corresponding @suse.com address on file.
-
-olaf@aepfle.de

docs/gitdm/companies/virtuozzo

@@ -1,2 +0,0 @@
-openvz.org
-virtuozzo.com

docs/gitdm/groups/education

@@ -1,17 +0,0 @@
-byu.net
-csiro.au
-epita.fr
-hibikino.ne.jp
-infn.it
-inria.fr
-isi.edu
-nict.go.jp
-parisdescartes.fr
-telecom-bretagne.eu
-tu-berlin.de
-tu-dresden.de
-ucla.edu
-upc.edu
-utah.edu
-uvt.ro
-wide.ad.jp

docs/gitdm/groups/opensource

@@ -1,13 +0,0 @@
-alpinelinux.org
-debian.org
-fedoraproject.org
-fsf.org
-gentoo.org
-gnome.org
-gnu.org
-kernel.org
-linux.com
-openbsd.org
-salasaga.org
-samba.org
-sdf.org

docs/gitdm/groups/unaffiliated

@@ -1,85 +0,0 @@
-# These are all domains you can get a personal email address from, so it's
-# fair to assume people using such addresses are contributing in their spare
-# time rather than on behalf of their respective employers.
-
-126.com
-gmail.com
-gmx.com
-googlemail.com
-hotmail.com
-mail.ru
-pobox.com
-protonmail.com
-riseup.net
-web.de
-yahoo.com
-
-# Same as the above, but for domains that don't generally allow random
-# people to sign up for an email address. In this case we list the email
-# addresses directly rather than just the domain, because we can't really
-# consider the domain itself one way or the other.
-
-=@eater.me
-adam@pandorasboxen.com
-agx@sigxcpu.org
-alexander.nusov@nfvexpress.com
-andres@lagarcavilla.org
-asad.saeed@acidseed.com
-atler@pld-linux.org
-benoar@dolka.fr
-beorn@binaries.fr
-bigon@bigon.be
-bugzilla.redhat.simon@arlott.org
-cardoe@cardoe.com
-charles@dyfis.net
-d.herrendoerfer@herrendoerfer.name
-dan@danny.cz
-debfx@fobos.de
-eike@sf-mail.de
-exo@tty.sk
-fritz@fritz-elfert.de
-gene@czarc.net
-gordon@dragonsdawn.net
-heathpetersen@kandre.com
-ibaldo@adinet.com.uy
-igor47@moomers.org
-infos@nafets.de
-intrigeri@boum.org
-james410@cowgill.org.uk
-james@shubin.ca
-jasper@humppa.nl
-jeremy@goop.org
-jk@ozlabs.org
-jwm@horde.net
-klaus@ethgen.de
-lacos@caesar.elte.hu
-lenaic@lhuard.fr.eu.org
-libvirt@dunquino.com
-lists@egidy.de
-marti@juffo.org
-max@rfc2324.org
-michael@ellerman.id.au
-mike@very.puzzling.org
-n0ano@n0ano.com
-neil@aldur.co.uk
-nobody@nowhere.ws
-peter@kieser.ca
-pieter@hollants.com
-raimue@codingfarm.de
-richard@nod.at
-rmy@tigress.co.uk
-ruben@rubenkerkhof.com
-rufo@rufoa.com
-slawek@kaplonski.pl
-soulxu@soulxu-thinkpad-t410.(none)
-stybla@turnovfree.net
-tai@rakugaki.org
-thomas@scripty.at
-v.tolstov@selfip.ru
-ville.skytta@iki.fi
-vincent@bernat.im
-wido@widodh.nl
-wiedi@frubar.net
-wongc-redhat@hoku.net
-xschen@tnsoft.com.cn
-yurchor@ukr.net

docs/governance.html.in

@@ -155,7 +155,7 @@
       also implicitly stating that they have the legal right to make the
       contribution, if doing so on behalf of a broader organization /
       company. Most of the project's code is distributed under the GNU
-      Lesser General Public License, version 2.1 or later. Details of the
+      Lesser General Public License, version 2 or later. Details of the
       exact license under which contributions will be presumed to be
       covered are found in the source repositories, or website in question.
     </p>

docs/hacking.html.in

@@ -29,11 +29,11 @@
         file from zanata.</p>
       </li>
 
-      <li><p>The simplest way to send patches is to use the
-        <a href="https://github.com/stefanha/git-publish"><code>git-publish</code></a>
-        tool. All libvirt-related repositories contain a config file that
-        tells git-publish to use the correct mailing list and subject prefix.</p>
-        <p>Alternatively, you may send patches using <code>git send-email</code>.</p>
+      <li><p>Post patches using <code>git send-email</code>, with git
+        rename detection enabled.  You need a one-time setup of:</p>
+<pre>
+  git config diff.renames true
+</pre>
         <p>Also, for code motion patches, you may find that <code>git
         diff --patience</code> provides an easier-to-read patch.
         However, the usual workflow of libvirt developer is:</p>
@@ -72,8 +72,8 @@
 </pre>
         <p>As a rule, patches should be sent to the mailing list only: all
         developers are subscribed to libvir-list and read it regularly, so
-        <strong>please don't CC individual developers</strong> unless
-        they've explicitly asked you to.</p>
+        please don't CC individual developers unless they've explicitly
+        asked you to.</p>
         <p>Avoid using mail clients for sending patches, as most of them
         will mangle the messages in some way, making them unusable for our
         purposes.  Gmail and other Web-based mail clients are particularly
@@ -81,11 +81,9 @@
         <p>If everything went well, your patch should show up on the
         <a href="https://www.redhat.com/archives/libvir-list/">libvir-list
         archives</a> in a matter of minutes; if you still can't find it on
-        there after an hour or so, you should double-check your setup.
-        <strong>Note that, if you are not already a subscriber, your very
-        first post to the mailing list will be
-        subject to moderation</strong>, and it's not uncommon for that to
-        take around a day.</p>
+        there after an hour or so, you should double-check your setup.  Note
+        that your very first post to the mailing list will be subject to
+        moderation, and it's not uncommon for that to take around a day.</p>
         <p>Please follow this as close as you can, especially the rebase and
         <code>git send-email</code> part, as it makes life easier for other
         developers to review your patch set.</p>
@@ -141,7 +139,14 @@
       </li>
 
       <li><p>Run the automated tests on your code before submitting any changes.
-          That is:
+          In particular, configure with compile warnings set to
+          -Werror.  This is done automatically for a git checkout; from a
+          tarball, use:</p>
+<pre>
+  ./configure --enable-werror
+</pre>
+        <p>
+          and run the tests:
         </p>
 <pre>
   make check
@@ -179,13 +184,12 @@
 
         <p>
           When debugging failures during development, it is possible
-          to focus in on just the failing subtests by using
-          VIR_TEST_RANGE. I.e. to run all tests from 3 to 20 with the
-          exception of tests 6 and 16, use:
+          to focus in on just the failing subtests by using TESTS and
+          VIR_TEST_RANGE:
         </p>
 
 <pre>
-  VIR_TEST_DEBUG=1 VIR_TEST_RANGE=3-5,7-20,^16 ./run tests/qemuxml2argvtest
+  make check VIR_TEST_DEBUG=1 VIR_TEST_RANGE=3-5 TESTS=qemuxml2argvtest
 </pre>
 
         <p>
@@ -339,36 +343,6 @@
         Richard Jones' guide to working with open source projects</a>.
     </p>
 
-    <h2><a id="lang">Language Usage</a></h2>
-
-    <p>
-      The libvirt repository makes use of a large number of programming
-      languages. It is anticipated that in the future libvirt will adopt
-      use of other new languages. To reduce the overall burden on developers,
-      there is thus a general desire to phase out usage of some of the
-      existing languages.
-    </p>
-
-    <p>
-      The preferred languages at this time are:
-    </p>
-
-    <ul>
-      <li>C - for the main libvirt codebase. Dialect supported by
-        GCC/CLang only.</li>
-      <li>Python - for supporting build scripts / tools. Code must
-        run with both version 2.7 and 3.x at this time.</li>
-    </ul>
-
-    <p>
-      Languages that should not be used for any new contributions:
-    </p>
-
-    <ul>
-      <li>Perl - build scripts must be written in Python instead.</li>
-      <li>Shell - build scripts must be written in Python instead.</li>
-    </ul>
-
     <h2><a id="tooling">Tooling</a></h2>
 
     <p>
@@ -852,39 +826,6 @@
   }
 </pre>
 
-    <h2><a id="conditions">Conditional expressions</a></h2>
-      <p>For readability reasons new code should avoid shortening comparisons
-        to 0 for numeric types. Boolean and pointer comparisions may be
-        shortened. All long forms are okay:
-      </p>
-<pre>
-   virFooPtr foos = NULL;
-   size nfoos = 0;
-   bool hasFoos = false;
-
-GOOD:
-    if (!foos)
-    if (!hasFoos)
-    if (nfoos == 0)
-    if (foos == NULL)
-    if (hasFoos == true)
-
-BAD:
-    if (!nfoos)
-    if (nfoos)
-</pre>
-      <p>New code should avoid the ternary operator as much as possible.
-        Specifically it must never span more than one line or nest:
-      </p>
-<pre>
-BAD:
-    char *foo = baz ?
-                virDoSomethingReallyComplex(driver, vm, something, baz->foo) :
-                NULL;
-
-    char *foo = bar ? bar->baz ? bar->baz->foo : "nobaz" : "nobar";
-</pre>
-
     <h2><a id="preprocessor">Preprocessor</a></h2>
 
     <p>Macros defined with an ALL_CAPS name should generally be
@@ -985,151 +926,99 @@ BAD:
       it points to, or it is aliased to another pointer that is.
     </p>
 
-    <h2><a id="attribute_annotations">Attribute annotations</a></h2>
-    <p>
-      Use the following annotations to help the compiler and/or static
-      analysis tools understand the code better:
-    </p>
-
-    <table class="top_table">
-        <tr><th>Macro</th><th>Meaning</th></tr>
-        <tr><td><code>ATTRIBUTE_NONNULL</code></td><td>passing NULL for this parameter is not allowed</td></tr>
-        <tr><td><code>ATTRIBUTE_PACKED</code></td><td>force a structure to be packed</td></tr>
-        <tr><td><code>G_GNUC_FALLTHROUGH</code></td><td>allow code reuse by multiple switch cases</td></tr>
-        <tr><td><code>G_GNUC_NO_INLINE</code></td><td>the function is mocked in the test suite</td></tr>
-        <tr><td><code>G_GNUC_NORETURN</code></td><td>the function never returns</td></tr>
-        <tr><td><code>G_GNUC_NULL_TERMINATED</code></td><td>last parameter must be NULL</td></tr>
-        <tr><td><code>G_GNUC_PRINTF</code></td><td>validate that the formatting string matches parameters</td></tr>
-        <tr><td><code>G_GNUC_UNUSED</code></td><td>parameter is unused in this implementation of the function</td></tr>
-        <tr><td><code>G_GNUC_WARN_UNUSED_RESULT</code></td><td>the return value must be checked</td></tr>
-    </table>
-
-    <h2><a id="glib">Adoption of GLib APIs</a></h2>
+    <h2><a id="memalloc">Low level memory management</a></h2>
 
     <p>
-      Libvirt has adopted use of the
-      <a href="https://developer.gnome.org/glib/stable/">GLib library</a>.
-      Due to libvirt's long history of development, there are many APIs
-      in libvirt, for which GLib provides an alternative solution. The
-      general rule to follow is that the standard GLib solution will be
-      preferred over historical libvirt APIs. Existing code will be
-      ported over to use GLib APIs over time, but new code should use
-      the GLib APIs straight away where possible.
+      Use of the malloc/free/realloc/calloc APIs is deprecated in the libvirt
+      codebase, because they encourage a number of serious coding bugs and do
+      not enable compile time verification of checks for NULL. Instead of these
+      routines, use the macros from viralloc.h.
     </p>
 
-    <p>
-      The following is a list of libvirt APIs that should no longer be
-      used in new code, and their suggested GLib replacements:
-    </p>
+    <ul>
+      <li><p>To allocate a single object:</p>
 
-    <dl>
-      <dt><code>VIR_ALLOC</code>, <code>VIR_REALLOC</code>,
-        <code>VIR_RESIZE_N</code>, <code>VIR_EXPAND_N</code>,
-        <code>VIR_SHRINK_N</code>, <code>VIR_FREE</code>,
-        <code>VIR_APPEND_ELEMENT</code>, <code>VIR_INSERT_ELEMENT</code>,
-        <code>VIR_DELETE_ELEMENT</code></dt>
-    <dd>Prefer the GLib APIs <code>g_new0</code>/<code>g_renew</code>/
-        <code>g_free</code> in most cases. There should rarely be a need
-        to use <code>g_malloc</code>/<code>g_realloc</code>.
-        Instead of using plain C arrays, it is preferrable to use
-        one of the GLib types, <code>GArray</code>, <code>GPtrArray</code>
-        or <code>GByteArray</code>. These
-        all use a struct to track the array memory and size together
-        and efficiently resize. <strong>NEVER MIX</strong> use of the
-        classic libvirt memory allocation APIs and GLib APIs within
-        a single method. Keep the style consistent, converting existing
-        code to GLib style in a separate, prior commit.</dd>
+<pre>
+  virDomainPtr domain;
 
-      <dt><code>virStrerror</code></dt>
-      <dd>The GLib <code>g_strerror()</code> function should be used instead,
-        which has a simpler calling convention as an added benefit.</dd>
+  if (VIR_ALLOC(domain) &lt; 0)
+      return NULL;
+</pre>
+      </li>
 
-    <table class="top_table">
-        <tr><th>deprecated version</th><th>GLib version</th><th>Notes</th></tr>
-        <tr><td><code>VIR_ALLOC(var)</code></td><td><code>g_new0(var_t, 1)</code></td>
-            <td>the type needs to be passed explicitly</td></tr>
-        <tr><td><code>VIR_ALLOC_N</code></td><td><code>g_new0(var_t, n)</code></td><td></td></tr>
-        <tr><td><code>VIR_REALLOC_N</code></td><td><code>g_renew(var_t, ptr, n)</code></td>
-            <td>the newly added memory is not zeroed</td></tr>
-        <tr><td><code>VIR_EXPAND_N</code></td><td><code>g_renew(var_t, ptr, n)</code></td>
-            <td>zero the new memory manually or use an array type</td></tr>
-        <tr><td><code>VIR_SHRINK_N</code></td><td><code>g_renew(var_t, ptr, n)</code></td>
-            <td></td></tr>
-        <tr><td><code>VIR_APPEND_ELEMENT</code></td><td><code>g_array_append_val</code></td>
-            <td><code>g_ptr_array_add</code> or <code>g_byte_array_append</code></td></tr>
-        <tr><td><code>VIR_INSERT_ELEMENT</code></td><td><code>g_array_insert_val</code></td>
-            <td><code>g_ptr_array_insert</code></td></tr>
-        <tr><td><code>VIR_DELETE_ELEMENT</code></td><td><code>g_array_remove_index</code></td>
-            <td><code>g_ptr_array_remove_index</code> or <code>g_byte_array_remove_index</code></td></tr>
-        <tr><td><code>VIR_FREE</code></td><td><code>g_free</code></td>
-            <td><code>g_free</code> does not zero the pointer</td></tr>
-    </table>
+      <li><p>To allocate an array of objects:</p>
+<pre>
+  virDomainPtr domains;
+  size_t ndomains = 10;
 
-    <p>String allocation macros and functions:</p>
-    <table class="top_table">
-        <tr><th>deprecated version</th><th>GLib version</th><th>Notes</th></tr>
-        <tr><td><code>virAsprintf</code></td><td><code>g_strdup_printf</code></td><td></td></tr>
-        <tr><td><code>virVasprintf</code></td><td><code>g_strdup_vprint</code></td>
-            <td>use <code>g_vasprintf</code> if you really need to know the returned length</td></tr>
-        <tr><td><code>virStrerror</code></td><td><code>g_strerror</code></td>
-            <td>the error strings are cached globally so no need to free it</td></tr>
-    </table>
-    </dl>
+  if (VIR_ALLOC_N(domains, ndomains) &lt; 0)
+      return NULL;
+</pre>
+      </li>
 
-    <p>
-      The following libvirt APIs have been deleted already:
-    </p>
-    <dl>
-      <dt><code>VIR_AUTOPTR</code>, <code>VIR_AUTOCLEAN</code>, <code>VIR_AUTOFREE</code></dt>
-      <dd>The GLib macros <code>g_autoptr</code>, <code>g_auto</code> and
-        <code>g_autofree</code> must be used
-        instead in all new code. In existing code, the GLib macros must
-        never be mixed with libvirt macros within a method, nor should
-        they be mixed with <code>VIR_FREE</code>. If introducing GLib macros to an
-        existing method, any use of libvirt macros must be converted
-        in an independent commit.
-      </dd>
+      <li><p>To allocate an array of object pointers:</p>
+<pre>
+  virDomainPtr *domains;
+  size_t ndomains = 10;
 
-      <dt><code>VIR_DEFINE_AUTOPTR_FUNC</code>, <code>VIR_DEFINE_AUTOCLEAN_FUNC</code></dt>
-      <dd>The GLib macros <code>G_DEFINE_AUTOPTR_CLEANUP_FUNC</code> and
-        <code>G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC</code> must be used in all
-        new code. Existing code should be converted to the
-        new macros where relevant. It is permissible to use
-        <code>g_autoptr</code>, <code>g_auto</code> on an object whose cleanup function
-        is declared with the libvirt macros and vice-versa.
-      </dd>
+  if (VIR_ALLOC_N(domains, ndomains) &lt; 0)
+      return NULL;
+</pre>
+      </li>
 
-      <dt><code>VIR_AUTOUNREF</code></dt>
-      <dd>The GLib macros <code>g_autoptr</code> and <code>G_DEFINE_AUTOPTR_CLEANUP_FUNC</code>
-        should be used to manage autoclean of virObject classes.
-        This matches usage with GObject classes.</dd>
+      <li><p>To re-allocate the array of domains to be 1 element
+      longer (however, note that repeatedly expanding an array by 1
+      scales quadratically, so this is recommended only for smaller
+      arrays):</p>
+<pre>
+  virDomainPtr domains;
+  size_t ndomains = 0;
 
-      <dt><code>VIR_STRDUP</code>, <code>VIR_STRNDUP</code></dt>
-      <dd>Prefer the GLib APIs <code>g_strdup</code> and <code>g_strndup</code>.</dd>
-    </dl>
-    <table class="top_table">
-        <tr><th>deleted version</th><th>GLib version</th><th>Notes</th></tr>
-        <tr><td><code>VIR_AUTOPTR</code></td><td><code>g_autoptr</code></td><td></td></tr>
-        <tr><td><code>VIR_AUTOCLEAN</code></td><td><code>g_auto</code></td><td></td></tr>
-        <tr><td><code>VIR_AUTOFREE</code></td><td><code>g_autofree</code></td><td>The GLib version does not use parentheses</td></tr>
-        <tr><td><code>VIR_AUTOUNREF</code></td><td><code>g_autoptr</code></td><td>The cleanup function needs to be defined</td></tr>
-        <tr><td><code>VIR_DEFINE_AUTOPTR_FUNC</code></td><td><code>G_DEFINE_AUTOPTR_CLEANUP_FUNC</code></td><td></td></tr>
-        <tr><td><code>VIR_DEFINE_AUTOCLEAN_FUNC</code></td><td><code>G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC</code></td><td></td></tr>
-        <tr><td><code>VIR_STEAL_PTR</code></td><td><code>g_steal_pointer</code></td>
-            <td><code>a = f(&amp;b)</code> instead of <code>f(a, b)</code></td></tr>
-        <tr><td><code>VIR_RETURN_PTR</code></td><td><code>return g_steal_pointer</code></td><td></td></tr>
-        <tr><td><code>ARRAY_CARDINALITY</code></td><td><code>G_N_ELEMENTS</code></td><td></td></tr>
-        <tr><td><code>ATTRIBUTE_FALLTHROUGH</code></td><td><code>G_GNUC_FALLTHROUGH</code></td><td></td></tr>
-        <tr><td><code>ATTRIBUTE_FMT_PRINTF</code></td><td><code>G_GNUC_PRINTF</code></td><td></td></tr>
-        <tr><td><code>ATTRIBUTE_NOINLINE</code></td><td><code>G_GNUC_NO_INLINE</code></td><td></td></tr>
-        <tr><td><code>ATTRIBUTE_NORETURN</code></td><td><code>G_GNUC_NORETURN</code></td><td></td></tr>
-        <tr><td><code>ATTRIBUTE_RETURN_CHECK</code></td><td><code>G_GNUC_WARN_UNUSED_RESULT</code></td><td></td></tr>
-        <tr><td><code>ATTRIBUTE_SENTINEL</code></td><td><code>G_GNUC_NULL_TERMINATED</code></td><td></td></tr>
-        <tr><td><code>ATTRIBUTE_UNUSED</code></td><td><code>G_GNUC_UNUSED</code></td><td></td></tr>
-        <tr><td><code>VIR_STRDUP</code></td><td><code>g_strdup</code></td><td></td></tr>
-        <tr><td><code>VIR_STRNDUP</code></td><td><code>g_strndup</code></td><td></td></tr>
-    </table>
+  if (VIR_EXPAND_N(domains, ndomains, 1) &lt; 0)
+      return NULL;
+  domains[ndomains - 1] = domain;
+</pre></li>
 
+      <li><p>To ensure an array has room to hold at least one more
+      element (this approach scales better, but requires tracking
+      allocation separately from usage)</p>
+
+<pre>
+  virDomainPtr domains;
+  size_t ndomains = 0;
+  size_t ndomains_max = 0;
+
+  if (VIR_RESIZE_N(domains, ndomains_max, ndomains, 1) &lt; 0)
+      return NULL;
+  domains[ndomains++] = domain;
+</pre>
+      </li>
+
+      <li><p>To trim an array of domains from its allocated size down
+      to the actual used size:</p>
+
+<pre>
+  virDomainPtr domains;
+  size_t ndomains = x;
+  size_t ndomains_max = y;
+
+  VIR_SHRINK_N(domains, ndomains_max, ndomains_max - ndomains);
+</pre></li>
+
+      <li><p>To free an array of domains:</p>
+<pre>
+  virDomainPtr domains;
+  size_t ndomains = x;
+  size_t ndomains_max = y;
+  size_t i;
+
+  for (i = 0; i &lt; ndomains; i++)
+      VIR_FREE(domains[i]);
+  VIR_FREE(domains);
+  ndomains_max = ndomains = 0;
+</pre>
+      </li>
+    </ul>
 
     <h2><a id="file_handling">File handling</a></h2>
 
@@ -1270,14 +1159,18 @@ BAD:
     </p>
 
 <pre>
-    dst = g_strdup(src);
-    dst = g_strndup(src, n);
+  VIR_STRDUP(char *dst, const char *src);
+  VIR_STRNDUP(char *dst, const char *src, size_t n);
 </pre>
     <p>
-      You should avoid using strdup or strndup directly as they do not handle
-      out-of-memory errors, and do not allow a NULL source.
-      Use <code>g_strdup</code> and <code>g_strndup</code> from GLib which
-      abort on OOM and handle NULL source by returning NULL.
+      You should avoid using strdup or strndup directly as they do not report
+      out-of-memory error, and do not allow a NULL source. Use
+      VIR_STRDUP or VIR_STRNDUP macros instead, which return 0 for
+      NULL source, 1 for successful copy, and -1 for allocation
+      failure with the error already reported. In very
+      specific cases, when you don't want to report the out-of-memory error, you
+      can use VIR_STRDUP_QUIET or VIR_STRNDUP_QUIET, but such usage is very rare
+      and usually considered a flaw.
     </p>
 
     <h2><a id="strbuf">Variable length string buffer</a></h2>
@@ -1285,11 +1178,7 @@ BAD:
     <p>
       If there is a need for complex string concatenations, avoid using
       the usual sequence of malloc/strcpy/strcat/snprintf functions and
-      make use of either the
-      <a href="https://developer.gnome.org/glib/stable/glib-Strings.html">GString</a>
-      type from GLib or the virBuffer API.
-      If formatting XML or QEMU command line is needed, use the virBuffer
-      API described in virbuffer.h, since it has helper functions for those.
+      make use of the virBuffer API described in virbuffer.h
     </p>
 
     <p>Typical usage is as follows:</p>
@@ -1298,14 +1187,12 @@ BAD:
   char *
   somefunction(...)
   {
-     g_auto(virBuffer) buf = VIR_BUFFER_INITIALIZER;
+     virBuffer buf = VIR_BUFFER_INITIALIZER;
 
      ...
 
      virBufferAddLit(&amp;buf, "&lt;domain&gt;\n");
      virBufferAsprintf(&amp;buf, "  &lt;memory&gt;%d&lt;/memory&gt;\n", memory);
-     if (some_error)
-         return NULL; /* g_auto will free the memory used so far */
      ...
      virBufferAddLit(&amp;buf, "&lt;/domain&gt;\n");
 
@@ -1374,12 +1261,12 @@ BAD:
       Whenever you add a new printf-style function, i.e., one with a format
       string argument and following "..." in its prototype, be sure to use
       gcc's printf attribute directive in the prototype.  For example, here's
-      the one for virCommandAddEnvFormat in vircommand.h:
+      the one for virAsprintf, in util.h:
     </p>
 
 <pre>
-  void virCommandAddEnvFormat(virCommandPtr cmd, const char *format, ...)
-      G_GNUC_PRINTF(2, 3);
+  int virAsprintf(char **strp, const char *fmt, ...)
+      ATTRIBUTE_FORMAT(printf, 2, 3);
 </pre>
 
     <p>
@@ -1389,40 +1276,14 @@ BAD:
     </p>
 
     <p>
-      When printing to a string, consider using GString or virBuffer for
-      incremental allocations, g_strdup_printf for a one-shot allocation,
-      and g_snprintf for fixed-width buffers.  Only use g_sprintf,
-      if you can prove the buffer won't overflow.
+      When printing to a string, consider using virBuffer for
+      incremental allocations, virAsprintf for a one-shot allocation,
+      and snprintf for fixed-width buffers.  Do not use sprintf, even
+      if you can prove the buffer won't overflow, since gnulib does
+      not provide the same portability guarantees for sprintf as it
+      does for snprintf.
     </p>
 
-    <h2><a id="errors">Error message format</a></h2>
-
-    <p>
-      Error messages visible to the user should be short and descriptive.  All
-      error messages are translated using gettext and thus must be wrapped in
-      <code>_()</code> macro.  To simplify the translation work, the error message
-      must not be concatenated from various parts.  To simplify searching for
-      the error message in the code the strings should not be broken even
-      if they result into a line longer than 80 columns and any formatting
-      modifier should be enclosed by quotes or other obvious separator.
-      If a string used with <code>%s</code> can be NULL the NULLSTR macro must
-      be used.
-    </p>
-
-<pre>
-  GOOD: virReportError(VIR_ERR_INTERNAL_ERROR,
-                       _("Failed to connect to remote host '%s'"), hostname)
-
-  BAD: virReportError(VIR_ERR_INTERNAL_ERROR,
-                      _("Failed to %s to remote host '%s'"),
-                      "connect", hostname);
-
-  BAD: virReportError(VIR_ERR_INTERNAL_ERROR,
-                      _("Failed to connect "
-                      "to remote host '%s'),
-                      hostname);
-</pre>
-
     <h2><a id="goto">Use of goto</a></h2>
 
     <p>
@@ -1442,16 +1303,11 @@ BAD:
       single label at the end of the function.  It's almost always ok
       to use this style.  In particular, if the cleanup code only
       involves free'ing memory, then having multiple labels is
-      overkill.  g_free() and most of the functions named XXXFree() in
-      libvirt is required to handle NULL as its arg. This does not
-      apply to libvirt's public APIs. Thus you can
+      overkill.  VIR_FREE() and every function named XXXFree() in
+      libvirt is required to handle NULL as its arg.  Thus you can
       safely call free on all the variables even if they were not yet
       allocated (yes they have to have been initialized to NULL).
       This is much simpler and clearer than having multiple labels.
-      Note that most of libvirt's type declarations can be marked with
-      either <code>g_autofree</code> or <code>g_autoptr</code> which uses
-      the compiler's <code>__attribute__((cleanup))</code> that calls
-      the appropriate free function when the variable goes out of scope.
     </p>
 
     <p>
@@ -1528,7 +1384,14 @@ int foo()
       how things work, it's better
       to wait for a more authoritative feedback though. Before committing, please
       also rebuild locally, run 'make check syntax-check', and make sure you
-      don't raise errors.
+      don't raise errors. Try to look for warnings too; for example,
+      configure with
+    </p>
+<pre>
+  --enable-compile-warnings=error
+</pre>
+    <p>
+      which adds -Werror to compile flags, so no warnings get missed
     </p>
 
     <p>
@@ -1548,10 +1411,6 @@ int foo()
         fixes for documentation and code comments can be managed
         in the same way, but still make sure they get reviewed if non-trivial.
       </li>
-      <li>(ir)regular pulls from other repositories or automated updates, such
-        as the .gnulib submodule updates, pulling in new translations or updating
-        the container images for the CI system
-      </li>
     </ul>
   </body>
 </html>

docs/hooks.html.in

@@ -91,8 +91,10 @@
   </network>
 &lt;/hookData&gt;</pre>
 
-    <p>In the case of an network port being created / deleted, the network
-       XML will be followed with the full XML description of the port:</p>
+    <p>In the case of an interface
+       being plugged/unplugged to/from the network, the network XML will be
+       followed with the full XML description of the domain containing the
+       interface that is being plugged/unplugged:</p>
 
 <pre>&lt;hookData&gt;
   &lt;network&gt;
@@ -100,11 +102,11 @@
      &lt;uuid&gt;afca425a-2c3a-420c-b2fb-dd7b4950d722&lt;/uuid&gt;
      ...
   &lt;/network&gt;
-  &lt;networkport&gt;
-    &lt;uuid&gt;5d744f21-ba4a-4d6e-bdb2-30a35ff3207d&lt;/uuid&gt;
-    ...
-    &lt;plug type='direct' dev='ens3' mode='vepa'/&gt;
-  &lt;/networkport&gt;
+  &lt;domain type='$domain_type' id='$domain_id'&gt;
+     &lt;name&gt;$domain_name&lt;/name&gt;
+     &lt;uuid&gt;afca425a-2c3a-420c-b2fb-dd7b4950d722&lt;/uuid&gt;
+     ...
+  &lt;/domain&gt;
 &lt;/hookData&gt;</pre>
 
     <p>Please note that this approach is different from other cases such as
@@ -294,15 +296,15 @@
           <pre>/etc/libvirt/hooks/network network_name stopped end -</pre></li>
       <li>Later, when network is started and there's an interface from a
         domain to be plugged into the network, the hook script is called as:<br/>
-          <pre>/etc/libvirt/hooks/network network_name port-created begin -</pre>
+          <pre>/etc/libvirt/hooks/network network_name plugged begin -</pre>
         Please note, that in this case, the script is passed both network and
-        port XMLs on its stdin.</li>
+        domain XMLs on its stdin.</li>
       <li>When network is updated, the hook script is called as:<br/>
           <pre>/etc/libvirt/hooks/network network_name updated begin -</pre></li>
       <li>When the domain from previous case is shutting down, the interface
         is unplugged. This leads to another script invocation:<br/>
-          <pre>/etc/libvirt/hooks/network network_name port-deleted begin -</pre>
-        And again, as in previous case, both network and port XMLs are passed
+          <pre>/etc/libvirt/hooks/network network_name unplugged begin -</pre>
+        And again, as in previous case, both network and domain XMLs are passed
         onto script's stdin.</li>
     </ul>
 

docs/hvsupport.pl

@@ -0,0 +1,437 @@
+#!/usr/bin/env perl
+
+use strict;
+use warnings;
+
+use File::Find;
+
+die "syntax: $0 SRCDIR\n" unless int(@ARGV) == 1;
+
+my $srcdir = shift @ARGV;
+
+my $symslibvirt = "$srcdir/libvirt_public.syms";
+my $symsqemu = "$srcdir/libvirt_qemu.syms";
+my $symslxc = "$srcdir/libvirt_lxc.syms";
+my @drivertable = (
+    "$srcdir/driver-hypervisor.h",
+    "$srcdir/driver-interface.h",
+    "$srcdir/driver-network.h",
+    "$srcdir/driver-nodedev.h",
+    "$srcdir/driver-nwfilter.h",
+    "$srcdir/driver-secret.h",
+    "$srcdir/driver-state.h",
+    "$srcdir/driver-storage.h",
+    "$srcdir/driver-stream.h",
+    );
+
+my %groupheaders = (
+    "virHypervisorDriver" => "Hypervisor APIs",
+    "virNetworkDriver" => "Virtual Network APIs",
+    "virInterfaceDriver" => "Host Interface APIs",
+    "virNodeDeviceDriver" => "Host Device APIs",
+    "virStorageDriver" => "Storage Pool APIs",
+    "virSecretDriver" => "Secret APIs",
+    "virNWFilterDriver" => "Network Filter APIs",
+    );
+
+
+my @srcs;
+find({
+    wanted => sub {
+        if (m!$srcdir/.*/\w+_(driver|common|tmpl|monitor|hal|udev)\.c$!) {
+            push @srcs, $_ if $_ !~ /vbox_driver\.c/;
+        }
+    }, no_chdir => 1}, $srcdir);
+
+# Map API functions to the header and documentation files they're in
+# so that we can generate proper hyperlinks to their documentation.
+#
+# The function names are grep'd from the XML output of apibuild.py.
+sub getAPIFilenames {
+    my $filename = shift;
+
+    my %files;
+    my $line;
+
+    open FILE, "<", $filename or die "cannot read $filename: $!";
+
+    while (defined($line = <FILE>)) {
+        if ($line =~ /function name='([^']+)' file='([^']+)'/) {
+            $files{$1} = $2;
+        }
+    }
+
+    close FILE;
+
+    if (keys %files == 0) {
+        die "No functions found in $filename. Has the apibuild.py output changed?";
+    }
+    return \%files;
+}
+
+sub parseSymsFile {
+    my $apisref = shift;
+    my $prefix = shift;
+    my $filename = shift;
+    my $xmlfilename = shift;
+
+    my $line;
+    my $vers;
+    my $prevvers;
+
+    my $filenames = getAPIFilenames($xmlfilename);
+
+    open FILE, "<$filename"
+        or die "cannot read $filename: $!";
+
+    while (defined($line = <FILE>)) {
+        chomp $line;
+        next if $line =~ /^\s*#/;
+        next if $line =~ /^\s*$/;
+        next if $line =~ /^\s*(global|local):/;
+        if ($line =~ /^\s*${prefix}_(\d+\.\d+\.\d+)\s*{\s*$/) {
+            if (defined $vers) {
+                die "malformed syms file";
+            }
+            $vers = $1;
+        } elsif ($line =~ /\s*}\s*;\s*$/) {
+            if (defined $prevvers) {
+                die "malformed syms file";
+            }
+            $prevvers = $vers;
+            $vers = undef;
+        } elsif ($line =~ /\s*}\s*${prefix}_(\d+\.\d+\.\d+)\s*;\s*$/) {
+            if ($1 ne $prevvers) {
+                die "malformed syms file $1 != $vers";
+            }
+            $prevvers = $vers;
+            $vers = undef;
+        } elsif ($line =~ /\s*(\w+)\s*;\s*$/) {
+            $$apisref{$1} = {};
+            $$apisref{$1}->{vers} = $vers;
+            $$apisref{$1}->{file} = $$filenames{$1};
+        } else {
+            die "unexpected data $line\n";
+        }
+    }
+
+    close FILE;
+}
+
+my %apis;
+# Get the list of all public APIs and their corresponding version
+parseSymsFile(\%apis, "LIBVIRT", $symslibvirt, "$srcdir/../docs/libvirt-api.xml");
+
+# And the same for the QEMU specific APIs
+parseSymsFile(\%apis, "LIBVIRT_QEMU", $symsqemu, "$srcdir/../docs/libvirt-qemu-api.xml");
+
+# And the same for the LXC specific APIs
+parseSymsFile(\%apis, "LIBVIRT_LXC", $symslxc, "$srcdir/../docs/libvirt-lxc-api.xml");
+
+
+# Some special things which aren't public APIs,
+# but we want to report
+$apis{virConnectSupportsFeature}->{vers} = "0.3.2";
+$apis{virDomainMigratePrepare}->{vers} = "0.3.2";
+$apis{virDomainMigratePerform}->{vers} = "0.3.2";
+$apis{virDomainMigrateFinish}->{vers} = "0.3.2";
+$apis{virDomainMigratePrepare2}->{vers} = "0.5.0";
+$apis{virDomainMigrateFinish2}->{vers} = "0.5.0";
+$apis{virDomainMigratePrepareTunnel}->{vers} = "0.7.2";
+
+$apis{virDomainMigrateBegin3}->{vers} = "0.9.2";
+$apis{virDomainMigratePrepare3}->{vers} = "0.9.2";
+$apis{virDomainMigratePrepareTunnel3}->{vers} = "0.9.2";
+$apis{virDomainMigratePerform3}->{vers} = "0.9.2";
+$apis{virDomainMigrateFinish3}->{vers} = "0.9.2";
+$apis{virDomainMigrateConfirm3}->{vers} = "0.9.2";
+
+$apis{virDomainMigrateBegin3Params}->{vers} = "1.1.0";
+$apis{virDomainMigratePrepare3Params}->{vers} = "1.1.0";
+$apis{virDomainMigratePrepareTunnel3Params}->{vers} = "1.1.0";
+$apis{virDomainMigratePerform3Params}->{vers} = "1.1.0";
+$apis{virDomainMigrateFinish3Params}->{vers} = "1.1.0";
+$apis{virDomainMigrateConfirm3Params}->{vers} = "1.1.0";
+
+
+
+# Now we want to get the mapping between public APIs
+# and driver struct fields. This lets us later match
+# update the driver impls with the public APis.
+
+my $line;
+
+# Group name -> hash of APIs { fields -> api name }
+my %groups;
+my $ingrp;
+foreach my $drivertable (@drivertable) {
+    open FILE, "<$drivertable"
+        or die "cannot read $drivertable: $!";
+
+    while (defined($line = <FILE>)) {
+        if ($line =~ /struct _(vir\w*Driver)/) {
+            my $grp = $1;
+            if ($grp ne "virStateDriver" &&
+                $grp ne "virStreamDriver") {
+                $ingrp = $grp;
+                $groups{$ingrp} = { apis => {}, drivers => {} };
+            }
+        } elsif ($ingrp) {
+            if ($line =~ /^\s*vir(?:Drv)(\w+)\s+(\w+);\s*$/) {
+                my $field = $2;
+                my $name = $1;
+
+                my $api;
+                if (exists $apis{"vir$name"}) {
+                    $api = "vir$name";
+                } elsif ($name =~ /\w+(Open|Close|URIProbe)/) {
+                    next;
+                } else {
+                    die "driver $name does not have a public API";
+                }
+                $groups{$ingrp}->{apis}->{$field} = $api;
+            } elsif ($line =~ /};/) {
+                $ingrp = undef;
+            }
+        }
+    }
+
+    close FILE;
+}
+
+
+# Finally, we read all the primary driver files and extract
+# the driver API tables from each one.
+
+foreach my $src (@srcs) {
+    open FILE, "<$src" or
+        die "cannot read $src: $!";
+
+    my $groups_regex = join("|", keys %groups);
+    $ingrp = undef;
+    my $impl;
+    while (defined($line = <FILE>)) {
+        if (!$ingrp) {
+            # skip non-matching lines early to save time
+            next if not $line =~ /$groups_regex/;
+
+            if ($line =~ /^\s*(?:static\s+)?($groups_regex)\s+(\w+)\s*=\s*{/ ||
+                $line =~ /^\s*(?:static\s+)?($groups_regex)\s+NAME\(\w+\)\s*=\s*{/) {
+                $ingrp = $1;
+                $impl = $src;
+
+                if ($impl =~ m,.*/node_device_(\w+)\.c,) {
+                    $impl = $1;
+                } else {
+                    $impl =~ s,.*/(\w+?)_((\w+)_)?(\w+)\.c,$1,;
+                }
+
+                if ($groups{$ingrp}->{drivers}->{$impl}) {
+                    die "Group $ingrp already contains $impl";
+                }
+
+                $groups{$ingrp}->{drivers}->{$impl} = {};
+            }
+
+        } else {
+            if ($line =~ m!\s*\.(\w+)\s*=\s*(\w+)\s*,?\s*(?:/\*\s*(\d+\.\d+\.\d+)\s*\*/\s*)?$!) {
+                my $api = $1;
+                my $meth = $2;
+                my $vers = $3;
+
+                next if $api eq "no" || $api eq "name";
+
+                die "Method $meth in $src is missing version" unless defined $vers || $api eq "connectURIProbe";
+
+                die "Driver method for $api is NULL in $src" if $meth eq "NULL";
+
+                if (!exists($groups{$ingrp}->{apis}->{$api})) {
+                    next if $api =~ /\w(Open|Close|URIProbe)/;
+
+                    die "Found unexpected method $api in $ingrp\n";
+                }
+
+                $groups{$ingrp}->{drivers}->{$impl}->{$api} = $vers;
+                if ($api eq "domainMigratePrepare" ||
+                    $api eq "domainMigratePrepare2" ||
+                    $api eq "domainMigratePrepare3") {
+                    $groups{$ingrp}->{drivers}->{$impl}->{"domainMigrate"} = $vers
+                        unless $groups{$ingrp}->{drivers}->{$impl}->{"domainMigrate"};
+                }
+
+            } elsif ($line =~ /}/) {
+                $ingrp = undef;
+            }
+        }
+    }
+
+    close FILE;
+}
+
+
+# The '.open' driver method is used for 3 public APIs, so we
+# have a bit of manual fixup todo with the per-driver versioning
+# and support matrix
+
+$groups{virHypervisorDriver}->{apis}->{"openAuth"} = "virConnectOpenAuth";
+$groups{virHypervisorDriver}->{apis}->{"openReadOnly"} = "virConnectOpenReadOnly";
+$groups{virHypervisorDriver}->{apis}->{"domainMigrate"} = "virDomainMigrate";
+
+my $openAuthVers = (0 * 1000 * 1000) + (4 * 1000) + 0;
+
+foreach my $drv (keys %{$groups{"virHypervisorDriver"}->{drivers}}) {
+    my $openVersStr = $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpen"};
+    my $openVers;
+    if ($openVersStr =~ /(\d+)\.(\d+)\.(\d+)/) {
+        $openVers = ($1 * 1000 * 1000) + ($2 * 1000) + $3;
+    }
+
+    # virConnectOpenReadOnly always matches virConnectOpen version
+    $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpenReadOnly"} =
+        $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpen"};
+
+    # virConnectOpenAuth is always 0.4.0 if the driver existed
+    # before this time, otherwise it matches the version of
+    # the driver's virConnectOpen entry
+    if ($openVersStr eq "Y" ||
+        $openVers >= $openAuthVers) {
+        $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpenAuth"} = $openVersStr;
+    } else {
+        $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpenAuth"} = "0.4.0";
+    }
+}
+
+
+# Another special case for the virDomainCreateLinux which was replaced
+# with virDomainCreateXML
+$groups{virHypervisorDriver}->{apis}->{"domainCreateLinux"} = "virDomainCreateLinux";
+
+my $createAPIVers = (0 * 1000 * 1000) + (0 * 1000) + 3;
+
+foreach my $drv (keys %{$groups{"virHypervisorDriver"}->{drivers}}) {
+    my $createVersStr = $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"domainCreateXML"};
+    next unless defined $createVersStr;
+    my $createVers;
+    if ($createVersStr =~ /(\d+)\.(\d+)\.(\d+)/) {
+        $createVers = ($1 * 1000 * 1000) + ($2 * 1000) + $3;
+    }
+
+    # virCreateLinux is always 0.0.3 if the driver existed
+    # before this time, otherwise it matches the version of
+    # the driver's virCreateXML entry
+    if ($createVersStr eq "Y" ||
+        $createVers >= $createAPIVers) {
+        $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"domainCreateLinux"} = $createVersStr;
+    } else {
+        $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"domainCreateLinux"} = "0.0.3";
+    }
+}
+
+
+# Finally we generate the HTML file with the tables
+
+print <<EOF;
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<body class="hvsupport">
+<h1>libvirt API support matrix</h1>
+
+<ul id="toc"></ul>
+
+<p>
+This page documents which <a href="html/">libvirt calls</a> work on
+which libvirt drivers / hypervisors, and which version the API appeared
+in.
+</p>
+
+EOF
+
+    foreach my $grp (sort { $a cmp $b } keys %groups) {
+    print "<h2><a name=\"$grp\">", $groupheaders{$grp}, "</a></h2>\n";
+    print <<EOF;
+<table class="top_table">
+<thead>
+<tr>
+<th>API</th>
+<th>Version</th>
+EOF
+
+    foreach my $drv (sort { $a cmp $b } keys %{$groups{$grp}->{drivers}}) {
+        print "  <th>$drv</th>\n";
+    }
+
+    print <<EOF;
+</tr>
+</thead>
+<tbody>
+EOF
+
+    my $row = 0;
+    foreach my $field (sort {
+        $groups{$grp}->{apis}->{$a}
+        cmp
+        $groups{$grp}->{apis}->{$b}
+        } keys %{$groups{$grp}->{apis}}) {
+        my $api = $groups{$grp}->{apis}->{$field};
+        my $vers = $apis{$api}->{vers};
+        my $htmlgrp = $apis{$api}->{file};
+        print <<EOF;
+<tr>
+<td>
+EOF
+
+        if (defined $htmlgrp) {
+            print <<EOF;
+<a href=\"html/libvirt-$htmlgrp.html#$api\">$api</a>
+EOF
+
+        } else {
+            print $api;
+        }
+        print <<EOF;
+</td>
+<td>$vers</td>
+EOF
+
+        foreach my $drv (sort {$a cmp $b } keys %{$groups{$grp}->{drivers}}) {
+            if (exists $groups{$grp}->{drivers}->{$drv}->{$field}) {
+                print "<td>", $groups{$grp}->{drivers}->{$drv}->{$field}, "</td>\n";
+            } else {
+                print "<td></td>\n";
+            }
+        }
+
+        print <<EOF;
+</tr>
+EOF
+
+        $row++;
+        if (($row % 15) == 0) {
+            print <<EOF;
+<tr>
+<th>API</th>
+<th>Version</th>
+EOF
+
+            foreach my $drv (sort { $a cmp $b } keys %{$groups{$grp}->{drivers}}) {
+                print "  <th>$drv</th>\n";
+            }
+
+        print <<EOF;
+</tr>
+EOF
+        }
+
+    }
+
+    print <<EOF;
+</tbody>
+</table>
+EOF
+}
+
+print <<EOF;
+</body>
+</html>
+EOF

docs/index.html.in

@@ -2,9 +2,20 @@
 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <script type="text/javascript" src="js/jquery-3.1.1.min.js"> </script>
+    <script type="text/javascript" src="js/moment.min.js"> </script>
+    <script type="text/javascript" src="js/jquery.rss.min.js"> </script>
+
     <script type="text/javascript">
       <!--
-      window.addEventListener("load", function() { fetchRSS() });
+      jQuery(function($) {
+        $("#planet").rss("http://planet.virt-tools.org/atom.xml", {
+          ssl: true,
+          layoutTemplate: '<dl>{entries}</dl>',
+          entryTemplate: '<dt><a href="{url}">{title}</a></dt><dd>by {author} on {date}</li>',
+          dateFormat: 'DD MMM YYYY'
+        })
+      })
       // -->
     </script>
   </head>
@@ -55,12 +66,9 @@
           <a href="formatstorageencryption.html">storage encryption</a>,
           <a href="formatcaps.html">capabilities</a>,
           <a href="formatdomaincaps.html">domain capabilities</a>,
-          <a href="formatstoragecaps.html">storage pool capabilities</a>,
           <a href="formatnode.html">node devices</a>,
           <a href="formatsecret.html">secrets</a>,
-          <a href="formatsnapshot.html">snapshots</a>,
-          <a href="formatcheckpoint.html">checkpoints</a>,
-          <a href="formatbackup.html">backup jobs</a></dd>
+          <a href="formatsnapshot.html">snapshots</a></dd>
         <dt><a href="http://wiki.libvirt.org">Wiki</a></dt>
         <dd>Read further community contributed content</dd>
       </dl>

docs/internals/oomtesting.html.in

@@ -0,0 +1,213 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body>
+    <h1>Out of memory testing</h1>
+
+    <ul id="toc"></ul>
+
+
+    <p>
+      This page describes how to use the test suite todo out of memory
+      testing.
+    </p>
+
+    <h2>Building with OOM testing</h2>
+
+    <p>
+      Since OOM testing requires hooking into the malloc APIs, it is
+      not enabled by default. The flag <code>--enable-test-oom</code>
+      must be given to <code>configure</code>. When this is done the
+      libvirt allocation APIs will have some hooks enabled.
+    </p>
+
+    <pre>
+$ ./configure --enable-test-oom
+</pre>
+
+
+    <h2><a id="basicoom">Basic OOM testing support</a></h2>
+
+    <p>
+      The first step in validating OOM usage is to run a test suite
+      with full OOM testing enabled. This is done by setting the
+      <code>VIR_TEST_OOM=1</code> environment variable. The way this
+      works is that it runs the test once normally to "prime" any
+      static memory allocations. Then it runs it once more counting
+      the total number of memory allocations. Then it runs it in a
+      loop failing a different memory allocation each time. For every
+      memory allocation failure triggered, it expects the test case
+      to return an error. OOM testing is quite slow requiring each
+      test case to be executed O(n) times, where 'n' is the total
+      number of memory allocations. This results in a total number
+      of memory allocations of '(n * (n + 1) ) / 2'
+    </p>
+
+    <pre>
+$ VIR_TEST_OOM=1 ./qemuxml2argvtest
+ 1) QEMU XML-2-ARGV minimal                                           ... OK
+    Test OOM for nalloc=42 .......................................... OK
+ 2) QEMU XML-2-ARGV minimal-s390                                      ... OK
+    Test OOM for nalloc=28 ............................ OK
+ 3) QEMU XML-2-ARGV machine-aliases1                                  ... OK
+    Test OOM for nalloc=38 ...................................... OK
+ 4) QEMU XML-2-ARGV machine-aliases2                                  ... OK
+    Test OOM for nalloc=38 ...................................... OK
+ 5) QEMU XML-2-ARGV machine-core-on                                   ... OK
+    Test OOM for nalloc=37 ..................................... OK
+...snip...
+</pre>
+
+    <p>
+      In this output, the first line shows the normal execution and
+      the test number, and the second line shows the total number
+      of memory allocations from that test case.
+    </p>
+
+    <h3><a id="valgrind">Tracking failures with valgrind</a></h3>
+
+    <p>
+      The test suite should obviously *not* crash during OOM testing.
+      If it does crash, then to assist in tracking down the problem
+      it is worth using valgrind and only running a single test case.
+      For example, supposing test case 5 crashed. Then re-run the
+      test with
+    </p>
+
+    <pre>
+$ VIR_TEST_OOM=1 VIR_TEST_RANGE=5 ../run valgrind ./qemuxml2argvtest
+...snip...
+ 5) QEMU XML-2-ARGV machine-core-on                                   ... OK
+    Test OOM for nalloc=37 ..................................... OK
+...snip...
+    </pre>
+
+    <p>
+      Valgrind should report the cause of the crash - for example a
+      double free or use of uninitialized memory or NULL pointer
+      access.
+    </p>
+
+    <h3><a id="stacktraces">Tracking failures with stack traces</a></h3>
+
+    <p>
+      With some really difficult bugs valgrind is not sufficient to
+      identify the cause. In this case, it is useful to identify the
+      precise allocation which was failed, to allow the code path
+      to the error to be traced. The <code>VIR_TEST_OOM</code>
+      env variable can be given a range of memory allocations to
+      test. So if a test case has 150 allocations, it can be told
+      to only test allocation numbers 7-10. The <code>VIR_TEST_OOM_TRACE</code>
+      variable can be used to print out stack traces.
+    </p>
+
+    <pre>
+$ VIR_TEST_OOM_TRACE=2 VIR_TEST_OOM=1:7-10 VIR_TEST_RANGE=5 \
+    ../run valgrind ./qemuxml2argvtest
+ 5) QEMU XML-2-ARGV machine-core-on                                   ... OK
+    Test OOM for nalloc=37 !virAllocN
+/home/berrange/src/virt/libvirt/src/util/viralloc.c:180
+virDomainDefParseXML
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:11786 (discriminator 1)
+virDomainDefParseNode
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:12677
+virDomainDefParse
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:12621
+testCompareXMLToArgvFiles
+/home/berrange/src/virt/libvirt/tests/qemuxml2argvtest.c:107
+virtTestRun
+/home/berrange/src/virt/libvirt/tests/testutils.c:266
+mymain
+/home/berrange/src/virt/libvirt/tests/qemuxml2argvtest.c:388 (discriminator 2)
+virtTestMain
+/home/berrange/src/virt/libvirt/tests/testutils.c:791
+__libc_start_main
+??:?
+_start
+??:?
+!virAlloc
+/home/berrange/src/virt/libvirt/src/util/viralloc.c:133
+virDomainDiskDefParseXML
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:4790
+virDomainDefParseXML
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:11797
+virDomainDefParseNode
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:12677
+virDomainDefParse
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:12621
+testCompareXMLToArgvFiles
+/home/berrange/src/virt/libvirt/tests/qemuxml2argvtest.c:107
+virtTestRun
+/home/berrange/src/virt/libvirt/tests/testutils.c:266
+mymain
+/home/berrange/src/virt/libvirt/tests/qemuxml2argvtest.c:388 (discriminator 2)
+virtTestMain
+/home/berrange/src/virt/libvirt/tests/testutils.c:791
+__libc_start_main
+??:?
+_start
+??:?
+!virAllocN
+/home/berrange/src/virt/libvirt/src/util/viralloc.c:180
+virXPathNodeSet
+/home/berrange/src/virt/libvirt/src/util/virxml.c:609
+virDomainDefParseXML
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:11805
+virDomainDefParseNode
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:12677
+virDomainDefParse
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:12621
+testCompareXMLToArgvFiles
+/home/berrange/src/virt/libvirt/tests/qemuxml2argvtest.c:107
+virtTestRun
+/home/berrange/src/virt/libvirt/tests/testutils.c:266
+mymain
+/home/berrange/src/virt/libvirt/tests/qemuxml2argvtest.c:388 (discriminator 2)
+virtTestMain
+/home/berrange/src/virt/libvirt/tests/testutils.c:791
+__libc_start_main
+??:?
+_start
+??:?
+!virAllocN
+/home/berrange/src/virt/libvirt/src/util/viralloc.c:180
+virDomainDefParseXML
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:11808 (discriminator 1)
+virDomainDefParseNode
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:12677
+virDomainDefParse
+/home/berrange/src/virt/libvirt/src/conf/domain_conf.c:12621
+testCompareXMLToArgvFiles
+/home/berrange/src/virt/libvirt/tests/qemuxml2argvtest.c:107
+virtTestRun
+/home/berrange/src/virt/libvirt/tests/testutils.c:266
+mymain
+/home/berrange/src/virt/libvirt/tests/qemuxml2argvtest.c:388 (discriminator 2)
+virtTestMain
+/home/berrange/src/virt/libvirt/tests/testutils.c:791
+__libc_start_main
+??:?
+_start
+??:?
+    </pre>
+
+    <h3><a id="noncrash">Non-crash related problems</a></h3>
+
+    <p>
+      Not all memory allocation bugs result in code crashing. Sometimes
+      the code will be silently ignoring the allocation failure, resulting
+      in incorrect data being produced. For example the XML parser may
+      mistakenly treat an allocation failure as indicating that an XML
+      attribute was not set in the input document. It is hard to identify
+      these problems from the test suite automatically. For this, the
+      test suites should be run with <code>VIR_TEST_DEBUG=1</code> set
+      and then stderr analysed for any unexpected data. For example,
+      the XML conversion may show an embedded "(null)" literal, or the
+      test suite might complain about missing elements / attributes
+      in the actual vs expected data. These are all signs of bugs in
+      OOM handling. In the future the OOM tests will be enhanced to
+      validate that an error VIR_ERR_NO_MEMORY is returned for each
+      allocation failed, rather than some other error.
+    </p>
+  </body>
+</html>

docs/internals/rpc.html.in

@@ -539,6 +539,13 @@ C <--  |32| 8 | 1 | 3 | 1 | 1 | 0 | .o.oOo |  <-- S  (reply)
         be part of the underlying server.
       </dd>
 
+      <dt><code>virNetServerMDNSPtr</code> (virnetservermdns.h)</dt>
+      <dd>The virNetServerMDNS APIs are used to advertise a server
+        across the local network, enabling clients to automatically
+        detect the existence of remote services. This is done by
+        interfacing with the Avahi mDNS advertisement service.
+      </dd>
+
       <dt><code>virNetServerClientPtr</code> (virnetserverclient.h)</dt>
       <dd>The virNetServerClient APIs are used to manage I/O related
         to a single client network connection. It handles initial

docs/js/jquery.rss.min.js

@@ -0,0 +1,11 @@
+(function(d){var e=function(a,b,c,f){this.target=a;this.url=b;this.html=[];this.effectQueue=[];this.options=d.extend({ssl:!1,host:"www.feedrapp.info",limit:null,key:null,layoutTemplate:"<ul>{entries}</ul>",entryTemplate:'<li><a href="{url}">[{author}@{date}] {title}</a><br/>{shortBodyPlain}</li>',tokens:{},outputMode:"json",dateFormat:"dddd MMM Do",dateLocale:"en",effect:"show",offsetStart:!1,offsetEnd:!1,error:function(){console.log("jQuery RSS: url doesn't link to RSS-Feed")},onData:function(){},
+success:function(){}},c||{});this.options.ssl&&"www.feedrapp.info"===this.options.host&&(this.options.host="feedrapp.herokuapp.com");this.callback=f||this.options.success};e.htmlTags="doctype,html,head,title,base,link,meta,style,script,noscript,body,article,nav,aside,section,header,footer,h1-h6,hgroup,address,p,hr,pre,blockquote,ol,ul,li,dl,dt,dd,figure,figcaption,div,table,caption,thead,tbody,tfoot,tr,th,td,col,colgroup,form,fieldset,legend,label,input,button,select,datalist,optgroup,option,textarea,keygen,output,progress,meter,details,summary,command,menu,del,ins,img,iframe,embed,object,param,video,audio,source,canvas,track,map,area,a,em,strong,i,b,u,s,small,abbr,q,cite,dfn,sub,sup,time,code,kbd,samp,var,mark,bdi,bdo,ruby,rt,rp,span,br,wbr".split(",");
+e.prototype.load=function(a){var b="http"+(this.options.ssl?"s":"")+"://"+this.options.host+"?callback=?&q="+encodeURIComponent(this.url);this.options.offsetStart&&this.options.offsetEnd&&(this.options.limit=this.options.offsetEnd);null!==this.options.limit&&(b+="&num="+this.options.limit);null!==this.options.key&&(b+="&key="+this.options.key);d.getJSON(b,a)};e.prototype.render=function(){var a=this;this.load(function(b){try{a.feed=b.responseData.feed,a.entries=b.responseData.feed.entries}catch(c){return a.entries=
+[],a.feed=null,a.options.error.call(a)}b=a.generateHTMLForEntries();a.target.append(b.layout);if(0!==b.entries.length){d.isFunction(a.options.onData)&&a.options.onData.call(a);var f=d(b.layout).is("entries")?b.layout:d("entries",b.layout);a.appendEntriesAndApplyEffects(f,b.entries)}0<a.effectQueue.length?a.executeEffectQueue(a.callback):d.isFunction(a.callback)&&a.callback.call(a)})};e.prototype.appendEntriesAndApplyEffects=function(a,b){var c=this;d.each(b,function(b,e){var d=c.wrapContent(e);"show"===
+c.options.effect?a.before(d):(d.css({display:"none"}),a.before(d),c.applyEffect(d,c.options.effect))});a.remove()};e.prototype.generateHTMLForEntries=function(){var a=this,b={entries:[],layout:null};d(this.entries).each(function(){var c=a.options.offsetStart,f=a.options.offsetEnd;c&&f?index>=c&&index<=f&&a.isRelevant(this,b.entries)&&(c=a.evaluateStringForEntry(a.options.entryTemplate,this),b.entries.push(c)):a.isRelevant(this,b.entries)&&(c=a.evaluateStringForEntry(a.options.entryTemplate,this),
+b.entries.push(c))});b.layout=this.options.entryTemplate?this.wrapContent(this.options.layoutTemplate.replace("{entries}","<entries></entries>")):this.wrapContent("<div><entries></entries></div>");return b};e.prototype.wrapContent=function(a){return 0!==d.trim(a).indexOf("<")?d("<div>"+a+"</div>"):d(a)};e.prototype.applyEffect=function(a,b,c){switch(b){case "slide":a.slideDown("slow",c);break;case "slideFast":a.slideDown(c);break;case "slideSynced":this.effectQueue.push({element:a,effect:"slide"});
+break;case "slideFastSynced":this.effectQueue.push({element:a,effect:"slideFast"})}};e.prototype.executeEffectQueue=function(a){var b=this;this.effectQueue.reverse();var c=function(){var f=b.effectQueue.pop();f?b.applyEffect(f.element,f.effect,c):a&&a()};c()};e.prototype.evaluateStringForEntry=function(a,b){var c=a,f=this;d(a.match(/(\{.*?\})/g)).each(function(){var a=this.toString();c=c.replace(a,f.getValueForToken(a,b))});return c};e.prototype.isRelevant=function(a,b){var c=this.getTokenMap(a);
+return this.options.filter?this.options.filterLimit&&this.options.filterLimit===b.length?!1:this.options.filter(a,c):!0};e.prototype.getFormattedDate=function(a){if(this.options.dateFormatFunction)return this.options.dateFormatFunction(a);return"undefined"!==typeof moment?(a=moment(new Date(a)),a=a.locale?a.locale(this.options.dateLocale):a.lang(this.options.dateLocale),a.format(this.options.dateFormat)):a};e.prototype.getTokenMap=function(a){if(!this.feedTokens){var b=JSON.parse(JSON.stringify(this.feed));
+delete b.entries;this.feedTokens=b}return d.extend({feed:this.feedTokens,url:a.link,author:a.author,date:this.getFormattedDate(a.publishedDate),title:a.title,body:a.content,shortBody:a.contentSnippet,bodyPlain:function(a){for(var a=a.content.replace(/<script[\\r\\\s\S]*<\/script>/mgi,"").replace(/<\/?[^>]+>/gi,""),b=0;b<e.htmlTags.length;b++)a=a.replace(RegExp("<"+e.htmlTags[b],"gi"),"");return a}(a),shortBodyPlain:a.contentSnippet.replace(/<\/?[^>]+>/gi,""),index:d.inArray(a,this.entries),totalEntries:this.entries.length,
+teaserImage:function(a){try{return a.content.match(/(<img.*?>)/gi)[0]}catch(b){return""}}(a),teaserImageUrl:function(a){try{return a.content.match(/(<img.*?>)/gi)[0].match(/src="(.*?)"/)[1]}catch(b){return""}}(a)},this.options.tokens)};e.prototype.getValueForToken=function(a,b){var c=this.getTokenMap(b),d=a.replace(/[\{\}]/g,""),d=c[d];if("undefined"!==typeof d)return"function"===typeof d?d(b,c):d;throw Error("Unknown token: "+a+", url:"+this.url);};d.fn.rss=function(a,b,c){(new e(this,a,b,c)).render();
+return this}})(jQuery);

docs/js/main.js

@@ -1,141 +0,0 @@
-"use strict";
-
-function pageload() {
-    window.addEventListener("scroll", function(e){
-        var distanceY = window.pageYOffset || document.documentElement.scrollTop;
-        var shrinkOn = 94;
-        var home = document.getElementById("home");
-        var links = document.getElementById("jumplinks");
-        var search = document.getElementById("search");
-        var body = document.getElementById("body");
-        if (distanceY > shrinkOn) {
-            if (home.className != "navhide") {
-                body.className = "navhide";
-                home.className = "navhide";
-                links.className = "navhide";
-                search.className = "navhide";
-            }
-        } else {
-            if (home.className == "navhide") {
-                body.className = "";
-                home.className = "";
-                links.className = "";
-                search.className = "";
-            }
-        }
-    });
-
-    /* Setting this class makes the advanced search options visible */
-    var advancedSearch = document.getElementById("advancedsearch");
-    advancedSearch.className = "advancedsearch";
-
-    var simpleSearch = document.getElementById("simplesearch");
-    simpleSearch.addEventListener("submit", advancedsearch);
-}
-
-function advancedsearch(e) {
-    e.preventDefault();
-    e.stopPropagation();
-
-    var form = document.createElement("form");
-    form.setAttribute("method", "get");
-
-    var newq = document.createElement("input");
-    newq.setAttribute("type", "hidden");
-    form.appendChild(newq);
-
-    var q = document.getElementById("searchq");
-    var whats = document.getElementsByName("what");
-    var what = "website";
-    for (var i = 0; i < whats.length; i++) {
-        if (whats[i].checked) {
-            what = whats[i].value;
-            break;
-        }
-    }
-
-    if (what == "website") {
-        form.setAttribute("action", "https://google.com/search");
-        newq.setAttribute("name", "q");
-        newq.value = "site:libvirt.org " + q.value;
-    } else if (what == "wiki") {
-        form.setAttribute("action", "https://wiki.libvirt.org/index.php");
-        newq.setAttribute("name", "search");
-        newq.value = q.value;
-    } else if (what == "devs") {
-        form.setAttribute("action", "https://google.com/search");
-        newq.setAttribute("name", "q");
-        newq.value = "site:redhat.com/archives/libvir-list " + q.value;
-    } else if (what == "users") {
-        form.setAttribute("action", "https://google.com/search");
-        newq.setAttribute("name", "q");
-        newq.value = "site:redhat.com/archives/libvirt-users " + q.value;
-    }
-
-    document.body.appendChild(form);
-    form.submit();
-
-    return false;
-}
-
-function fetchRSS() {
-    if (document.location.protocol == "file:")
-        return;
-
-    var planet = document.getElementById("planet");
-    if (planet === null)
-        return;
-
-    var req = new XMLHttpRequest();
-    req.open("GET", "https://planet.virt-tools.org/atom.xml");
-    req.setRequestHeader("Accept", "application/atom+xml, text/xml");
-    req.onerror = function(e) {
-        if (this.statusText != "")
-            console.error(this);
-    };
-    req.onload = function(e) {
-        if (this.readyState !== 4)
-            return;
-
-        if (this.status != 200) {
-            console.error(this.statusText);
-            return;
-        }
-
-        if (this.responseXML === null) {
-            console.error("Atom response is not an XML");
-            return;
-        }
-
-        var dl = document.createElement("dl");
-        var dateOpts = { day: "numeric", month: "short", year: "numeric"};
-
-        var entries = this.responseXML.querySelectorAll("feed > entry:not(:nth-of-type(1n+5))");
-
-        entries.forEach(function(e) {
-            var name = e.querySelector("author > name").textContent;
-            var title = e.querySelector("title").textContent;
-            var updated = e.querySelector("updated").textContent;
-            var link = e.querySelector("link").attributes.href.textContent;
-
-            var a = document.createElement("a");
-            a.href = link;
-            a.innerText = title;
-
-            var dt = document.createElement("dt");
-            dt.appendChild(a);
-            dl.appendChild(dt);
-
-            var date = new Date(updated);
-            date = date.toLocaleDateString("default", dateOpts);
-
-            var dd = document.createElement("dd");
-            dd.innerText = ` by ${name} on ${date}`;
-
-            dl.appendChild(dd);
-        });
-
-        planet.appendChild(dl);
-    };
-    req.send();
-}

docs/kbase.html.in

@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body class="docs">
-    <h2>Knowledge base</h2>
-
-    <div class="panel">
-      <dl>
-        <dt><a href="kbase/locking.html">Disk locking</a></dt>
-        <dd>Ensuring exclusive guest access to disks with
-          <a href="kbase/locking-lockd.html">virtlockd</a> or
-          <a href="kbase/locking-sanlock.html">Sanlock</a></dd>
-
-        <dt><a href="kbase/secureusage.html">Secure usage</a></dt>
-        <dd>Secure usage of the libvirt APIs</dd>
-
-        <dt><a href="kbase/launch_security_sev.html">Launch security</a></dt>
-        <dd>Securely launching VMs with AMD SEV</dd>
-
-        <dt><a href="kbase/domainstatecapture.html">Domain state
-            capture</a></dt>
-        <dd>Comparison between different methods of capturing domain
-          state</dd>
-
-        <dt><a href="kbase/rpm-deployment.html">RPM deployment</a></dt>
-        <dd>Explanation of the different RPM packages and illustration of
-          which to pick for installation</dd>
-
-        <dt><a href="kbase/backing_chains.html">Backing chain management</a></dt>
-        <dd>Explanation of how disk backing chain specification impacts libvirt's
-          behaviour and basic troubleshooting steps of disk problems.</dd>
-      </dl>
-    </div>
-
-    <br class="clear"/>
-
-  </body>
-</html>

docs/kbase/backing_chains.rst

@@ -1,185 +0,0 @@
-=================
-Disk image chains
-=================
-
-Modern disk image formats allow users to create an overlay on top of an
-existing image which will be the target of the new guest writes. This allows us
-to do snapshots of the disk state of a VM efficiently. The following text
-describes how libvirt manages such image chains and some problems which can
-occur. Note that many of the cases mentioned below are currently only relevant
-for the qemu driver.
-
-.. contents::
-
-Domain XML image and chain specification
-========================================
-
-Disk image chains can be partially or fully configured in the domain XML. The
-basic approach is to use the ``<backingStore>`` elements in the configuration.
-
-The ``<backingStore>`` elements present in the live VM xml represent the actual
-topology that libvirt knows of.
-
-Basic disk setup
-----------------
-
-Any default configuration or example usually refers only to the top (active)
-image of the backing chain.
-
-::
-
-  <disk type='file' device='disk'>
-    <driver name='qemu' type='qcow2'/>
-    <source file='/tmp/pull4.qcow2'/>
-    <target dev='vda' bus='virtio'/>
-    <address type='pci' domain='0x0000' bus='0x00' slot='0x0a' function='0x0'/>
-  </disk>
-
-This configuration will prompt libvirt to detect the backing image of the source
-image and recursively do the same thing until the end of the chain.
-
-Importance of properly setup backing chain
-------------------------------------------
-
-The disk image locations are used by libvirt to properly setup the security
-system used on the host so that the hypervisor can access the files and possibly
-also directly to configure the hypervisor to use the appropriate images. Thus
-it's important to properly setup the formats and paths of the backing images.
-
-Image detection caveats
------------------------
-
-Detection of the backing chain requires libvirt to read and understand the
-``backing file`` field recorded in the image metadata and also being able to
-recurse and read the backing file. Due to security implications libvirt
-will not attempt to detect the format of the backing image if the image metadata
-doesn't contain it.
-
-Libvirt also might lack support for a network disk storage technology and thus
-may be unable to visit and detect backing chains on such storage. This may
-result in the backing chain present in the live XML to look incomplete or some
-operations not being possible. To prevent this it's possible to specify the
-image metadata explicitly in the XML.
-
-Advanced backing chain specifications
--------------------------------------
-
-To specify the topology of disk images explicitly the following XML
-specification can be used:
-
-::
-
- <disk type='file' device='disk'>
-   <driver name='qemu' type='qcow2'/>
-   <source file='/tmp/pull4.qcow2'/>
-   <backingStore type='file'>
-     <format type='qcow2'/>
-     <source file='/tmp/pull3.qcow2'/>
-     <backingStore type='file'>
-       <format type='qcow2'/>
-       <source file='/tmp/pull2.qcow2'/>
-       <backingStore type='file'>
-         <format type='qcow2'/>
-         <source file='/tmp/pull1.qcow2'/>
-         <backingStore type='file'>
-           <format type='qcow2'/>
-           <source file='/tmp/pull0.qcow2'/>
-           <backingStore/>
-         </backingStore>
-       </backingStore>
-     </backingStore>
-   </backingStore>
-   <target dev='vda' bus='virtio'/>
-   <address type='pci' domain='0x0000' bus='0x00' slot='0x0a' function='0x0'/>
- </disk>
-
-This makes libvirt follow the settings as configured in the XML. Note that this
-is supported only when the https://libvirt.org/formatdomaincaps.html#featureBackingStoreInput
-capability is present.
-
-An empty ``<backingStore/>`` element signals the end of the chain. Using this
-will prevent libvirt or qemu from probing the backing chain.
-
-Note that it's also possible to partially specify the chain in the XML but omit
-the terminating element. This will result into probing from the last specified
-``<backingStore>``
-
-
-Manual image creation
-=====================
-
-When creating disk images manually outside of libvirt it's important to create
-them properly so that they work with libvirt as expected. The created disk
-images must contain the format of the backing image in the metadata. This
-means that the **-F** parameter of ``qemu-img`` must always be used.
-
-Troubleshooting
-===============
-
-A few common problems which occur when managing chains of disk images.
-
-VM refuses to start due to misconfigured backing store format
--------------------------------------------------------------
-
-This problem happens on VMs where the backing chain was created manually outside
-of libvirt and can have multiple symptoms:
-
-- permission denied error reported on a backing image
-- ``format of backing image '%s' of image '%s' was not specified in the image metadata`` error reported
-- disk image looking corrupt inside the guest
-
-The cause of the above problem is that the image metadata does not record the
-format of the backing image along with the location of the image. When the
-format is not specified libvirt or qemu would have to do image format probing
-which is insecure to do as a malicious guest could rewrite the header of the
-disk leading to access of host files. Libvirt thus does not try to assume
-the format of the backing image. The following command can be used to check if
-the image has a backing image format specified:
-
-::
-
- $ qemu-img info /tmp/copy4.qcow2
- image: /tmp/copy4.qcow2
- file format: qcow2
- virtual size: 10 MiB (10485760 bytes)
- disk size: 196 KiB
- cluster_size: 65536
- backing file: copy3.qcow2 (actual path: /tmp/copy3.qcow2)
- backing file format: qcow2
- Format specific information:
-     compat: 1.1
-     lazy refcounts: false
-     refcount bits: 16
-     corrupt: false
-
-If the ``backing file format:`` field is missing above the format was not
-specified properly. The image can be fixed by the following command:
-
-::
-
- qemu-img rebase -f $IMAGE_FORMAT -F $BACKING_IMAGE_FORMAT -b $BACKING_IMAGE_PATH $IMAGE_PATH
-
-It is important to fill out ``$BACKING_IMAGE_FORMAT`` and ``$IMAGE_FORMAT``
-properly. ``$BACKING_IMAGE_PATH`` should be specified as a full absolute path.
-If relative referencing of the backing image is desired, the path must be
-relative to the location of image described by ``$IMAGE_PATH``.
-
-Missing images reported after after moving disk images into a different path
-----------------------------------------------------------------------------
-
-The path to the backing image which is recorded in the image metadata often
-contains a full path to the backing image. This is the default libvirt-created
-image configuration. When such images are moved to a different location the
-top image will no longer point to the correct image.
-
-To fix such issue you can either fully specify the image chain in the domain XML
-as pointed out above or the following ``qemu-img`` command can be used:
-
-::
-
- qemu-img rebase -u -f $IMAGE_FORMAT -F $BACKING_IMAGE_FORMAT -b $BACKING_IMAGE_PATH $IMAGE_PATH
-
-It is important to fill out ``$BACKING_IMAGE_FORMAT`` and ``$IMAGE_FORMAT``
-properly. ``$BACKING_IMAGE_PATH`` should be specified as a full absolute path.
-If relative referencing of the backing image is desired, the path must be
-relative to the location of image described by ``$IMAGE_PATH``.

docs/kbase/domainstatecapture.rst

@@ -1,255 +0,0 @@
-==================================
-Domain state capture using Libvirt
-==================================
-
-.. contents::
-
-In order to aid application developers to choose which operations best
-suit their needs, this page compares the different means for capturing
-state related to a domain managed by libvirt.
-
-The information here is primarily geared towards capturing the state of
-an active domain. Capturing the state of an inactive domain essentially
-amounts to copying the contents of guest disks, followed by a fresh boot
-of the same domain configuration with disks restored back to that saved
-state.
-
-State capture trade-offs
-========================
-
-One of the features made possible with virtual machines is live
-migration -- transferring all state related to the guest from one host
-to another with minimal interruption to the guest's activity. In this
-case, state includes domain memory (including register and device
-contents), and domain storage (whether the guest's view of the disks are
-backed by local storage on the host, or by the hypervisor accessing
-shared storage over a network). A clever observer will then note that if
-all state is available for live migration, then there is nothing
-stopping a user from saving some or all of that state at a given point
-of time in order to be able to later rewind guest execution back to the
-state it previously had. The astute reader will also realize that state
-capture at any level requires that the data must be stored and managed
-by some mechanism. This processing might fit in a single file, or more
-likely require a chain of related files, and may require synchronization
-with third-party tools built around managing the amount of data
-resulting from capturing the state of multiple guests that each use
-multiple disks.
-
-There are several libvirt APIs associated with capturing the state of a
-guest, which can later be used to rewind that guest to the conditions it
-was in earlier. The following is a list of trade-offs and differences
-between the various facets that affect capturing domain state for active
-domains:
-
-Duration
-   Capturing state can be a lengthy process, so while the captured state
-   ideally represents an atomic point in time corresponding to something
-   the guest was actually executing, capturing state tends to focus on
-   minimizing guest downtime while performing the rest of the state
-   capture in parallel with guest execution. Some interfaces require
-   up-front preparation (the state captured is not complete until the
-   API ends, which may be some time after the command was first
-   started), while other interfaces track the state when the command was
-   first issued, regardless of the time spent in capturing the rest of
-   the state. Also, time spent in state capture may be longer than the
-   time required for live migration, when state must be duplicated
-   rather than shared.
-Amount of state
-   For an online guest, there is a choice between capturing the guest's
-   memory (all that is needed during live migration when the storage is
-   already shared between source and destination), the guest's disk
-   state (all that is needed if there are no pending guest I/O
-   transactions that would be lost without the corresponding memory
-   state), or both together. Reverting to partial state may still be
-   viable, but typically, booting from captured disk state without
-   corresponding memory is comparable to rebooting a machine that had
-   power cut before I/O could be flushed. Guests may need to use proper
-   journaling methods to avoid problems when booting from partial state.
-Quiescing of data
-   Even if a guest has no pending I/O, capturing disk state may catch
-   the guest at a time when the contents of the disk are inconsistent.
-   Cooperating with the guest to perform data quiescing is an optional
-   step to ensure that captured disk state is fully consistent without
-   requiring additional memory state, rather than just crash-consistent.
-   But guest cooperation may also have time constraints, where the guest
-   can rightfully panic if there is too much downtime while I/O is
-   frozen.
-Quantity of files
-   When capturing state, some approaches store all state within the same
-   file (internal), while others expand a chain of related files that
-   must be used together (external), for more files that a management
-   application must track.
-Impact to guest definition
-   Capturing state may require temporary changes to the guest
-   definition, such as associating new files into the domain definition.
-   While state capture should never impact the running guest, a change
-   to the domain's active XML may have impact on other host operations
-   being performed on the domain.
-Third-party integration
-   When capturing state, there are tradeoffs to how much of the process
-   must be done directly by the hypervisor, and how much can be
-   off-loaded to third-party software. Since capturing state is not
-   instantaneous, it is essential that any third-party integration see
-   consistent data even if the running guest continues to modify that
-   data after the point in time of the capture.
-Full vs. incremental
-   When periodically repeating the action of state capture, it is useful
-   to minimize the amount of state that must be captured by exploiting
-   the relation to a previous capture, such as focusing only on the
-   portions of the disk that the guest has modified in the meantime.
-   Some approaches are able to take advantage of checkpoints to provide
-   an incremental backup, while others are only capable of a full backup
-   even if that means re-capturing unchanged portions of the disk.
-Local vs. remote
-   Domains that completely use remote storage may only need some
-   mechanism to keep track of guest memory state while using external
-   means to manage storage. Still, hypervisor and guest cooperation to
-   ensure points in time when no I/O is in flight across the network can
-   be important for properly capturing disk state.
-Network latency
-   Whether it's domain storage or saving domain state into remote
-   storage, network latency has an impact on snapshot data. Having
-   dedicated network capacity, bandwidth, or quality of service levels
-   may play a role, as well as planning for how much of the backup
-   process needs to be local.
-
-An example of the various facets in action is migration of a running
-guest. In order for the guest to be able to resume on the destination at
-the same place it left off at the source, the hypervisor has to get to a
-point where execution on the source is stopped, the last remaining
-changes occurring since the migration started are then transferred, and
-the guest is started on the target. The management software thus must
-keep track of the starting point and any changes since the starting
-point. These last changes are often referred to as dirty page tracking
-or dirty disk block bitmaps. At some point in time during the migration,
-the management software must freeze the source guest, transfer the dirty
-data, and then start the guest on the target. This period of time must
-be minimal. To minimize overall migration time, one is advised to use a
-dedicated network connection with a high quality of service.
-Alternatively saving the current state of the running guest can just be
-a point in time type operation which doesn't require updating the "last
-vestiges" of state prior to writing out the saved state file. The state
-file is the point in time of whatever is current and may contain
-incomplete data which if used to restart the guest could cause confusion
-or problems because some operation wasn't completed depending upon where
-in time the operation was commenced.
-
-State capture APIs
-==================
-
-With those definitions, the following libvirt APIs related to state
-capture have these properties:
-
-`virDomainManagedSave <../html/libvirt-libvirt-domain.html#virDomainManagedSave>`__
-   This API saves guest memory, with libvirt managing all of the saved
-   state, then stops the guest. While stopped, the disks can be copied
-   by a third party. However, since any subsequent restart of the guest
-   by libvirt API will restore the memory state (which typically only
-   works if the disk state is unchanged in the meantime), and since it
-   is not possible to get at the memory state that libvirt is managing,
-   this is not viable as a means for rolling back to earlier saved
-   states, but is rather more suited to situations such as suspending a
-   guest prior to rebooting the host in order to resume the guest when
-   the host is back up. This API also has a drawback of potentially long
-   guest downtime, and therefore does not lend itself well to live
-   backups.
-`virDomainSave <../html/libvirt-libvirt-domain.html#virDomainSave>`__
-   This API is similar to virDomainManagedSave(), but moves the burden
-   on managing the stored memory state to the user. As such, the user
-   can now couple saved state with copies of the disks to perform a
-   revert to an arbitrary earlier saved state. However, changing who
-   manages the memory state does not change the drawback of potentially
-   long guest downtime when capturing state.
-`virDomainSnapshotCreateXML <../html/libvirt-libvirt-domain-snapshot.html#virDomainSnapshotCreateXML>`__
-   This API wraps several approaches for capturing guest state, with a
-   general premise of creating a snapshot (where the current guest
-   resources are frozen in time and a new wrapper layer is opened for
-   tracking subsequent guest changes). It can operate on both offline
-   and running guests, can choose whether to capture the state of
-   memory, disk, or both when used on a running guest, and can choose
-   between internal and external storage for captured state. However, it
-   is geared towards post-event captures (when capturing both memory and
-   disk state, the disk state is not captured until all memory state has
-   been collected first). Using QEMU as the hypervisor, internal
-   snapshots currently have lengthy downtime that is incompatible with
-   freezing guest I/O, but external snapshots are quick when memory
-   contents are not also saved. Since creating an external snapshot
-   changes which disk image resource is in use by the guest, this API
-   can be coupled with
-   `virDomainBlockCommit() <html/libvirt-libvirt-domain.html#virDomainBlockCommit>`__
-   to restore things back to the guest using its original disk image,
-   where a third-party tool can read the backing file prior to the live
-   commit. See also the `XML details <formatsnapshot.html>`__ used with
-   this command.
-`virDomainFSFreeze <html/libvirt-libvirt-domain.html#virDomainFSFreeze>`__, `virDomainFSThaw <html/libvirt-libvirt-domain.html#virDomainFSThaw>`__
-   This pair of APIs does not directly capture guest state, but can be
-   used to coordinate with a trusted live guest that state capture is
-   about to happen, and therefore guest I/O should be quiesced so that
-   the state capture is fully consistent, rather than merely crash
-   consistent. Some APIs are able to automatically perform a freeze and
-   thaw via a flags parameter, rather than having to make separate calls
-   to these functions. Also, note that freezing guest I/O is only
-   possible with trusted guests running a guest agent, and that some
-   guests place maximum time limits on how long I/O can be frozen.
-`virDomainCheckpointCreateXML <html/libvirt-libvirt-domain-checkpoint.html#virDomainCheckpointCreateXML>`__
-   This API does not actually capture guest state, rather it makes it
-   possible to track which portions of guest disks have changed between
-   a checkpoint and the current live execution of the guest. However,
-   while it is possible use this API to create checkpoints in isolation,
-   it is more typical to create a checkpoint as a side-effect of
-   starting a new incremental backup with ``virDomainBackupBegin()`` or
-   at the creation of an external snapshot with
-   ``virDomainSnapshotCreateXML2()``, since a second incremental backup
-   is most useful when using the checkpoint created during the first.
-   See also the `XML details <formatcheckpoint.html>`__ used with this
-   command.
-`virDomainBackupBegin <html/libvirt-libvirt-domain.html#virDomainBackupBegin>`__, `virDomainBackupEnd <html/libvirt-libvirt-domain.html#virDomainBackupEnd>`__
-   This API wraps approaches for capturing the state of disks of a
-   running guest, but does not track accompanying guest memory state.
-   The capture is consistent to the start of the operation, where the
-   captured state is stored independently from the disk image in use
-   with the guest and where it can be easily integrated with a
-   third-party for capturing the disk state. Since the backup operation
-   is stored externally from the guest resources, there is no need to
-   commit data back in at the completion of the operation. When coupled
-   with checkpoints, this can be used to capture incremental backups
-   instead of full.
-
-Examples
-========
-
-The following two sequences both accomplish the task of capturing the
-disk state of a running guest, then wrapping things up so that the guest
-is still running with the same file as its disk image as before the
-sequence of operations began. The difference between the two sequences
-boils down to the impact of an unexpected interruption made at any point
-in the middle of the sequence: with such an interruption, the first
-example leaves the guest tied to a temporary wrapper file rather than
-the original disk, and requires manual clean up of the domain
-definition; while the second example has no impact to the domain
-definition.
-
-Backup via temporary snapshot
------------------------------
-
-::
-
-   virDomainFSFreeze()
-   virDomainSnapshotCreateXML(VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY)
-   virDomainFSThaw()
-   third-party copy the backing file to backup storage # most time spent here
-   virDomainBlockCommit(VIR_DOMAIN_BLOCK_COMMIT_ACTIVE) per disk
-   wait for commit ready event per disk
-   virDomainBlockJobAbort() per disk
-
-
-Direct backup
--------------
-
-::
-
-   virDomainFSFreeze()
-   virDomainBackupBegin()
-   virDomainFSThaw()
-   wait for push mode event, or pull data over NBD # most time spent here
-   virDomainBackupEnd()

docs/kbase/launch_security_sev.rst

@@ -1,529 +0,0 @@
-============================
-Launch security with AMD SEV
-============================
-
-.. contents::
-
-Storage encryption in modern public cloud computing is a common
-practice. However, from the point of view of a user of these cloud
-workloads, a significant amount of trust needs to be put in the cloud
-platform security as well as integrity (was the hypervisor tampered?).
-For this reason there's ever rising demand for securing data in use,
-i.e. memory encryption. One of the solutions addressing this matter is
-AMD SEV.
-
-AMD Secure Encrypted Virtualization (SEV)
-=========================================
-
-SEV (Secure Encrypted Virtualization) is a feature extension of AMD's
-SME (Secure Memory Encryption) intended for KVM virtual machines which
-is supported primarily on AMD's EPYC CPU line. In contrast to SME, SEV
-uses a unique memory encryption key for each VM. The whole encryption of
-memory pages is completely transparent to the hypervisor and happens
-inside dedicated hardware in the on-die memory controller. Each
-controller includes a high-performance Advanced Encryption Standard
-(AES) engine that encrypts data when it is written to DRAM and decrypts
-it when read. For more details about the technology itself, you can
-visit `AMD's developer portal <https://developer.amd.com/sev/>`__.
-
-Enabling SEV on the host
-========================
-
-Before VMs can make use of the SEV feature you need to make sure your
-AMD CPU does support SEV. You can check whether SEV is among the CPU
-flags with:
-
-::
-
-   $ cat /proc/cpuinfo | grep sev
-   ...
-   sme ssbd sev ibpb
-
-Next step is to enable SEV in the kernel, because it is disabled by
-default. This is done by putting the following onto the kernel command
-line:
-
-::
-
-   mem_encrypt=on kvm_amd.sev=1
-
-To make the changes persistent, append the above to the variable holding
-parameters of the kernel command line in ``/etc/default/grub`` to
-preserve SEV settings across reboots
-
-::
-
-   $ cat /etc/default/grub
-   ...
-   GRUB_CMDLINE_LINUX="... mem_encrypt=on kvm_amd.sev=1"
-   $ grub2-mkconfig -o /boot/efi/EFI/<distro>/grub.cfg
-
-``mem_encrypt=on`` turns on the SME memory encryption feature on the
-host which protects against the physical attack on the hypervisor
-memory. The ``kvm_amd.sev`` parameter actually enables SEV in the kvm
-module. It can be set on the command line alongside ``mem_encrypt`` like
-shown above, or it can be put into a module config under
-``/etc/modprobe.d/``
-
-::
-
-   $ cat /etc/modprobe.d/sev.conf
-   options kvm_amd sev=1
-
-After rebooting the host, you should see SEV being enabled in the
-kernel:
-
-::
-
-   $ cat /sys/module/kvm_amd/parameters/sev
-   1
-
-
-Checking SEV support in the virt stack
-======================================
-
-**Note: All of the commands bellow need to be run with root
-privileges.**
-
-First make sure you have the following packages in the specified
-versions:
-
--  libvirt >= 4.5.0 (>5.1.0 recommended due to additional SEV bugfixes)
--  QEMU >= 2.12.0
-
-To confirm that the virtualization stack supports SEV, run the
-following:
-
-::
-
-   # virsh domcapabilities
-   <domainCapabilities>
-   ...
-     <features>
-       ...
-       <sev supported='yes'>
-         <cbitpos>47</cbitpos>
-         <reducedPhysBits>1</reducedPhysBits>
-       </sev>
-       ...
-     </features>
-   </domainCapabilities>
-
-Note that if libvirt was already installed and libvirtd running before
-enabling SEV in the kernel followed by the host reboot you need to force
-libvirtd to re-probe both the host and QEMU capabilities. First stop
-libvirtd:
-
-::
-
-   # systemctl stop libvirtd.service
-
-Now you need to clean the capabilities cache:
-
-::
-
-   # rm -f /var/cache/libvirt/qemu/capabilities/*
-
-If you now restart libvirtd, it will re-probe the capabilities and if
-you now run:
-
-::
-
-   # virsh domcapabilities
-
-SEV should be listed as supported. If you still see:
-
-::
-
-   <sev supported='no'/>
-
-it means one of two things:
-
-#. libvirt does support SEV, but either QEMU or the host does not
-#. you have libvirt <=5.1.0 which suffered from getting a
-   ``'Permission denied'`` on ``/dev/sev`` because of the default
-   permissions on the character device which prevented QEMU from opening
-   it during capabilities probing - you can either manually tweak the
-   permissions so that QEMU has access to it or preferably install
-   libvirt 5.1.0 or higher
-
-VM Configuration
-================
-
-SEV is enabled in the XML by specifying the
-`<launchSecurity> <https://libvirt.org/formatdomain.html#launchSecurity>`__
-element. However, specifying ``launchSecurity`` isn't enough to boot an
-SEV VM. Further configuration requirements are discussed below.
-
-Machine type
-------------
-
-Even though both Q35 and legacy PC machine types (for PC see also
-"virtio") can be used with SEV, usage of the legacy PC machine type is
-strongly discouraged, since depending on how your OVMF package was built
-(e.g. including features like SecureBoot or SMM) Q35 may even be
-required.
-
-Q35
-~~~
-
-::
-
-   ...
-   <os>
-     <type arch='x86_64' machine='pc-q35-3.0'>hvm</type>
-     ...
-   </os>
-   ...
-
-i440fx (discouraged)
-~~~~~~~~~~~~~~~~~~~~
-
-::
-
-   ...
-   <os>
-     <type arch='x86_64' machine='pc-i440fx-3.0'>hvm</type>
-     ...
-   </os>
-   ...
-
-Boot loader
------------
-
-SEV is only going to work with OVMF (UEFI), so you'll need to point
-libvirt to the correct OVMF binary.
-
-::
-
-   ...
-   <os>
-     <type arch='x86_64' machine='pc-q35-3.0'>hvm</type>
-     <loader readonly='yes' type='pflash'>/usr/share/edk2/ovmf/OVMF_CODE.fd</loader>
-   </os>
-   ...
-
-Memory
-------
-
-Internally, SEV expects that the encrypted memory pages won't be swapped
-out or move around so the VM memory needs to be pinned in physical RAM
-which will be handled by QEMU. Apart from that, certain memory regions
-allocated by QEMU itself (UEFI pflash, device ROMs, video RAM, etc.)
-have to be encrypted as well. This causes a conflict in how libvirt
-tries to protect the host. By default, libvirt enforces a memory hard
-limit on each VM's cgroup in order to protect the host from malicious
-QEMU to allocate and lock all the available memory. This limit
-corresponds to the total memory allocation for the VM given by
-``<currentMemory>`` element. However, trying to account for the
-additional memory regions QEMU allocates when calculating the limit in
-an automated manner is non-deterministic. One way to resolve this is to
-set the hard limit manually.
-
-Note: Figuring out the right number so that your guest boots and isn't
-killed is challenging, but 256MiB extra memory over the total guest RAM
-should suffice for most workloads and may serve as a good starting
-point. For example, a domain with 4GB memory with a 256MiB extra hard
-limit would look like this:
-
-::
-
-   # virsh edit <domain>
-   <domain>
-     ...
-     <currentMemory unit='KiB'>4194304</currentMemory>
-     <memtune>
-       <hard_limit unit='KiB'>4456448</hard_limit>
-     </memtune>
-     ...
-   </domain>
-
-There's another, preferred method of taking care of the limits by using
-the\ ``<memoryBacking>`` element along with the ``<locked/>``
-subelement:
-
-::
-
-   <domain>
-     ...
-     <memoryBacking>
-       <locked/>
-     </memoryBacking>
-     ...
-   </domain>
-
-What that does is that it tells libvirt not to force any hard limit
-(well, unlimited) upon the VM cgroup. The obvious advantage is that one
-doesn't need to determine the hard limit for every single SEV-enabled
-VM. However, there is a significant security-related drawback to this
-approach. Since no hard limit is applied, a malicious QEMU could perform
-a DoS attack by locking all of the host's available memory. The way to
-avoid this issue and to protect the host is to enforce a bigger hard
-limit on the master cgroup containing all of the VMs - on systemd this
-is ``machine.slice``.
-
-::
-
-   # systemctl set-property machine.slice MemoryHigh=<value>
-
-To put even stricter measures in place which would involve the OOM
-killer, use
-
-::
-
-   # systemctl set-property machine.slice MemoryMax=<value>
-
-instead. Alternatively, you can create a systemd config (don't forget to
-reload systemd configuration in this case):
-
-::
-
-   # cat << EOF > /etc/systemd/system.control/machine.slice.d/90-MemoryMax.conf
-   MemoryMax=<value>
-   EOF
-
-The trade-off to keep in mind with the second approach is that the VMs
-can still perform DoS on each other.
-
-Virtio
-------
-
-In order to make virtio devices work, we need to enable emulated IOMMU
-on the devices so that virtual DMA can work.
-
-::
-
-   # virsh edit <domain>
-   <domain>
-     ...
-     <controller type='virtio-serial' index='0'>
-       <driver iommu='on'/>
-     </controller>
-     <controller type='scsi' index='0' model='virtio-scsi'>
-       <driver iommu='on'/>
-     </controller>
-     ...
-     <memballoon model='virtio'>
-       <driver iommu='on'/>
-     </memballoon>
-     <rng model='virtio'>
-       <backend model='random'>/dev/urandom</backend>
-       <driver iommu='on'/>
-     </rng>
-     ...
-   <domain>
-
-If you for some reason want to use the legacy PC machine type, further
-changes to the virtio configuration is required, because SEV will not
-work with Virtio <1.0. In libvirt, this is handled by using the
-virtio-non-transitional device model (libvirt >= 5.2.0 required).
-
-Note: some devices like video devices don't support non-transitional
-model, which means that virtio GPU cannot be used.
-
-::
-
-   <domain>
-     ...
-     <devices>
-       ...
-       <memballoon model='virtio-non-transitional'>
-         <driver iommu='on'/>
-       </memballoon>
-     </devices>
-     ...
-   </domain>
-
-Checking SEV from within the guest
-==================================
-
-After making the necessary adjustments discussed in
-`Configuration <#Configuration>`__, the VM should now boot successfully
-with SEV enabled. You can then verify that the guest has SEV enabled by
-running:
-
-::
-
-   # dmesg | grep -i sev
-   AMD Secure Encrypted Virtualization (SEV) active
-
-Limitations
-===========
-
-Currently, the boot disk cannot be of type virtio-blk, instead,
-virtio-scsi needs to be used if virtio is desired. This limitation is
-expected to be lifted with future releases of kernel (the kernel used at
-the time of writing the article is 5.0.14). If you still cannot start an
-SEV VM, it could be because of wrong SELinux label on the ``/dev/sev``
-device with selinux-policy <3.14.2.40 which prevents QEMU from touching
-the device. This can be resolved by upgrading the package, tuning the
-selinux policy rules manually to allow svirt_t to access the device (see
-``audit2allow`` on how to do that) or putting SELinux into permissive
-mode (discouraged).
-
-Full domain XML examples
-========================
-
-Q35 machine
------------
-
-::
-
-   <domain type='kvm'>
-     <name>sev-dummy</name>
-     <memory unit='KiB'>4194304</memory>
-     <currentMemory unit='KiB'>4194304</currentMemory>
-     <memoryBacking>
-       <locked/>
-     </memoryBacking>
-     <vcpu placement='static'>4</vcpu>
-     <os>
-       <type arch='x86_64' machine='pc-q35-3.0'>hvm</type>
-       <loader readonly='yes' type='pflash'>/usr/share/edk2/ovmf/OVMF_CODE.fd</loader>
-       <nvram>/var/lib/libvirt/qemu/nvram/sev-dummy_VARS.fd</nvram>
-     </os>
-     <features>
-       <acpi/>
-       <apic/>
-       <vmport state='off'/>
-     </features>
-     <cpu mode='host-model' check='partial'>
-       <model fallback='allow'/>
-     </cpu>
-     <clock offset='utc'>
-       <timer name='rtc' tickpolicy='catchup'/>
-       <timer name='pit' tickpolicy='delay'/>
-       <timer name='hpet' present='no'/>
-     </clock>
-     <on_poweroff>destroy</on_poweroff>
-     <on_reboot>restart</on_reboot>
-     <on_crash>destroy</on_crash>
-     <pm>
-       <suspend-to-mem enabled='no'/>
-       <suspend-to-disk enabled='no'/>
-     </pm>
-     <devices>
-       <emulator>/usr/bin/qemu-kvm</emulator>
-       <disk type='file' device='disk'>
-         <driver name='qemu' type='qcow2'/>
-         <source file='/var/lib/libvirt/images/sev-dummy.qcow2'/>
-         <target dev='sda' bus='scsi'/>
-         <boot order='1'/>
-       </disk>
-       <controller type='virtio-serial' index='0'>
-         <driver iommu='on'/>
-       </controller>
-       <controller type='scsi' index='0' model='virtio-scsi'>
-         <driver iommu='on'/>
-       </controller>
-       <interface type='network'>
-         <mac address='52:54:00:cc:56:90'/>
-         <source network='default'/>
-         <model type='virtio'/>
-         <driver iommu='on'/>
-       </interface>
-       <graphics type='spice' autoport='yes'>
-         <listen type='address'/>
-         <gl enable='no'/>
-       </graphics>
-       <video>
-         <model type='qxl'/>
-       </video>
-       <memballoon model='virtio'>
-         <driver iommu='on'/>
-       </memballoon>
-       <rng model='virtio'>
-         <driver iommu='on'/>
-       </rng>
-     </devices>
-     <launchSecurity type='sev'>
-       <cbitpos>47</cbitpos>
-       <reducedPhysBits>1</reducedPhysBits>
-       <policy>0x0003</policy>
-     </launchSecurity>
-   </domain>
-
-PC-i440fx machine
------------------
-
-::
-
-   <domain type='kvm'>
-     <name>sev-dummy-legacy</name>
-     <memory unit='KiB'>4194304</memory>
-     <currentMemory unit='KiB'>4194304</currentMemory>
-     <memtune>
-       <hard_limit unit='KiB'>5242880</hard_limit>
-     </memtune>
-     <vcpu placement='static'>4</vcpu>
-     <os>
-       <type arch='x86_64' machine='pc-i440fx-3.0'>hvm</type>
-       <loader readonly='yes' type='pflash'>/usr/share/edk2/ovmf/OVMF_CODE.fd</loader>
-       <nvram>/var/lib/libvirt/qemu/nvram/sev-dummy_VARS.fd</nvram>
-       <boot dev='hd'/>
-     </os>
-     <features>
-     <acpi/>
-     <apic/>
-     <vmport state='off'/>
-     </features>
-     <cpu mode='host-model' check='partial'>
-       <model fallback='allow'/>
-     </cpu>
-     <clock offset='utc'>
-       <timer name='rtc' tickpolicy='catchup'/>
-       <timer name='pit' tickpolicy='delay'/>
-       <timer name='hpet' present='no'/>
-     </clock>
-     <on_poweroff>destroy</on_poweroff>
-     <on_reboot>restart</on_reboot>
-     <on_crash>destroy</on_crash>
-     <pm>
-       <suspend-to-mem enabled='no'/>
-       <suspend-to-disk enabled='no'/>
-     </pm>
-     <devices>
-       <emulator>/usr/bin/qemu-kvm</emulator>
-       <disk type='file' device='disk'>
-         <driver name='qemu' type='qcow2'/>
-         <source file='/var/lib/libvirt/images/sev-dummy-seabios.qcow2'/>
-         <target dev='sda' bus='sata'/>
-       </disk>
-       <interface type='network'>
-         <mac address='52:54:00:d8:96:c8'/>
-         <source network='default'/>
-         <model type='virtio-non-transitional'/>
-       </interface>
-       <serial type='pty'>
-         <target type='isa-serial' port='0'>
-           <model name='isa-serial'/>
-         </target>
-       </serial>
-       <console type='pty'>
-         <target type='serial' port='0'/>
-       </console>
-       <input type='tablet' bus='usb'>
-         <address type='usb' bus='0' port='1'/>
-       </input>
-       <input type='mouse' bus='ps2'/>
-       <input type='keyboard' bus='ps2'/>
-       <graphics type='spice' autoport='yes'>
-         <listen type='address'/>
-         <gl enable='no'/>
-       </graphics>
-       <video>
-         <model type='qxl' ram='65536' vram='65536' vgamem='16384' heads='1' primary='yes'/>
-       </video>
-       <memballoon model='virtio-non-transitional'>
-         <driver iommu='on'/>
-       </memballoon>
-         <rng model='virtio-non-transitional'>
-       <driver iommu='on'/>
-       </rng>
-     </devices>
-     <launchSecurity type='sev'>
-       <cbitpos>47</cbitpos>
-       <reducedPhysBits>1</reducedPhysBits>
-       <policy>0x0003</policy>
-     </launchSecurity>
-   </domain>