[PATCH 32/32] docs: formatdomain-devices: Split out <vsock>

Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/formatdomain-devices-vsock.rst | 22 ++++++++++++++++++++++ docs/formatdomain-devices.rst | 24 +----------------------- docs/meson.build | 1 + 3 files changed, 24 insertions(+), 23 deletions(-) create mode 100644 docs/formatdomain-devices-vsock.rst diff --git a/docs/formatdomain-devices-vsock.rst b/docs/formatdomain-devices-vsock.rst new file mode 100644 index 0000000000..37771201a9 --- /dev/null +++ b/docs/formatdomain-devices-vsock.rst @@ -0,0 +1,22 @@ +:anchor:`<a id="vsock"/>` + +Vsock +----- + +A vsock host/guest interface. The ``model`` attribute defaults to ``virtio``. +:since:`Since 5.2.0` ``model`` can also be 'virtio-transitional' and +'virtio-non-transitional', see `Virtio transitional +devices <#elementsVirtioTransitional>`__ for more details. The optional +attribute ``address`` of the ``cid`` element specifies the CID assigned to the +guest. If the attribute ``auto`` is set to ``yes``, libvirt will assign a free +CID automatically on domain startup. :since:`Since 4.4.0` + +:: + + ... + <devices> + <vsock model='virtio'> + <cid auto='no' address='3'/> + </vsock> + </devices> + ... diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index 39887bc1bf..ae8f8836e7 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -64,26 +64,4 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3.9.0` .. include:: formatdomain-devices-shmem.rst .. include:: formatdomain-devices-memory.rst .. include:: formatdomain-devices-iommu.rst - -:anchor:`<a id="vsock"/>` - -Vsock ------ - -A vsock host/guest interface. The ``model`` attribute defaults to ``virtio``. -:since:`Since 5.2.0` ``model`` can also be 'virtio-transitional' and -'virtio-non-transitional', see `Virtio transitional -devices <#elementsVirtioTransitional>`__ for more details. The optional -attribute ``address`` of the ``cid`` element specifies the CID assigned to the -guest. If the attribute ``auto`` is set to ``yes``, libvirt will assign a free -CID automatically on domain startup. :since:`Since 4.4.0` - -:: - - ... - <devices> - <vsock model='virtio'> - <cid auto='no' address='3'/> - </vsock> - </devices> - ... +.. include:: formatdomain-devices-vsock.rst diff --git a/docs/meson.build b/docs/meson.build index 86d98a1558..44d282ee7d 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -149,6 +149,7 @@ docs_rst_files = [ 'formatdomain-devices-shmem.rst', 'formatdomain-devices-memory.rst', 'formatdomain-devices-iommu.rst', + 'formatdomain-devices-vsock.rst', ] }, { 'name': 'hacking' }, -- 2.26.2