From 1e1cf8e66b556c51427400e97570e0963d59a228 Mon Sep 17 00:00:00 2001 From: Cole Robinson Date: Wed, 6 Mar 2019 18:25:16 -0500 Subject: [PATCH] docs: formatdomaincaps: Describe optional XML changes Acked-by: Michal Privoznik Signed-off-by: Cole Robinson --- docs/formatdomaincaps.html.in | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in index ba48daab2d..2583f9bead 100644 --- a/docs/formatdomaincaps.html.in +++ b/docs/formatdomaincaps.html.in @@ -37,6 +37,17 @@ management application to choose an appropriate mode for a pass-through host device as well as which adapter to utilize.

+

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 <disk supported='yes'/> is present, you can safely + assume the driver supports <disk> devices. If <disk supported='no'/> is + present, you can safely assume the driver does NOT support <disk> + devices. If the <disk> block is omitted entirely, the driver is not + indicating one way or the other whether it supports <disk> devices, and + applications should not interpret the missing block to mean any thing in + particular.

+

Element and attribute overview

A new query interface was added to the virConnect API's to retrieve the