[libvirt PATCH v3 11/11] docs: note node device fields that are read-only

Jonathon Jongsma jjongsma at redhat.com
Tue Jun 16 14:27:59 UTC 2020


As noted by Erik Skultety, we use the same XML schema to report
existing devices and to define new devices. However, some schema
elements are "read-only". In other words, they are used to report
information from the node device driver and cannot be used to define a
new device. Note these in the documentation.

Signed-off-by: Jonathon Jongsma <jjongsma at redhat.com>
---
 docs/formatnode.html.in | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in
index 0637d457ee..e4328fedbe 100644
--- a/docs/formatnode.html.in
+++ b/docs/formatnode.html.in
@@ -31,11 +31,16 @@
         name is just the bus type and address, as in
         "pci_0000_00_02_1" or "usb_1_5_3", but some devices are able
         to provide more specific names, such as
-        "net_eth1_00_27_13_6a_fe_00".
+        "net_eth1_00_27_13_6a_fe_00". This is a read-only field that is
+        reported by the device driver. If this element is set when defining a
+        new device, it will be ignored.
+
       </dd>
       <dt><code>path</code></dt>
       <dd>
-        Fully qualified sysfs path to the device.
+        Fully qualified sysfs path to the device. This is a read-only field
+        that is reported by the device driver. If this element is set when
+        defining a new device, it will be ignored.
       </dd>
       <dt><code>parent</code></dt>
       <dd>
-- 
2.21.3




More information about the libvir-list mailing list