[libvirt PATCH 1/2] domxml-to-native: add disclaimer about fd passing

[Ján Tomko]

For some configs where FD passing is used, we cannot generate
a corresponding native config without writing extra code
just for domxml-to-native.

Add a disclaimer to the API documentation and the virsh man page.

Signed-off-by: Ján Tomko <jtomko at redhat.com>
---
 docs/manpages/virsh.rst | 2 ++
 src/libvirt-domain.c    | 3 +++
 2 files changed, 5 insertions(+)

diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
index 20936994ce..673dc8f434 100644
--- a/docs/manpages/virsh.rst
+++ b/docs/manpages/virsh.rst
@@ -2532,6 +2532,8 @@ Convert the file *xml* into domain XML format or convert an existing
 *--domain* to the native guest configuration format named by *format*.
 The *xml* and *--domain* arguments are mutually exclusive. For the types
 of *format* argument, refer to ``domxml-from-native``.
+Note that some domain configs cannot be converted to the native format,
+because they rely on passing pre-opened file descriptors.
 
 
 dump
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 4eb14d4176..156939fe22 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -2675,6 +2675,9 @@ virConnectDomainXMLFromNative(virConnectPtr conn,
  * a native configuration file describing the domain.
  * The format of the native data is hypervisor dependent.
  *
+ * Note that some configs cannot be converted to the native format,
+ * because they rely on passing pre-opened file descriptors.
+ *
  * Returns a 0 terminated UTF-8 encoded native config datafile, or
  * NULL in case of error. The caller must free() the returned value.
  */
-- 
2.31.1