External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-17 07:07:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

virConnectDomainXMLToNative: Add note about dynamically configured features

Browse Source 
In the qemu driver certain configs such as disk throttling or CPU
hotplug is configured by interacting with the monitor at the startup
phase of the hypervisor and thus is not part of the "native config" as
returned by 'virConnectDomainXMLToNative'.

Similarly at least the commandline for qemu contains resources passed
via file descriptors which are obviously not part of the returned
"native config".

Add a paragraph into the documentation outlining that the native
configuration might not be completely usable.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
This commit is contained in:
Peter Krempa 2022-05-16 12:56:22 +02:00
parent 7bbfabc6b2
commit 6272e780e2
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/libvirt-domain.c
View File

@ -2909,6 +2909,13 @@ virConnectDomainXMLFromNative(virConnectPtr conn,
* a native configuration file describing the domain.
* The format of the native data is hypervisor dependent.
*
* Note that certain hypervisor drivers such as the QEMU driver configure many
* aspects of the domain dynamically via hypervisor APIs and that may not be
* part of the returned native configuration format. Similarly certain resources
* are passed to the hypervisor via file descriptors, which are not part of the
* native configuration returned by this API. Such configuration is thus not
* trivially usable outside of libvirt.
*
* Returns a 0 terminated UTF-8 encoded native config datafile, or
* NULL in case of error. The caller must free() the returned value.
*