Bug 1925848 - docs: More explicit description in libvirt docs
Summary: docs: More explicit description in libvirt docs
Keywords:
Status: CLOSED DEFERRED
Alias: None
Product: Red Hat Enterprise Linux Advanced Virtualization
Classification: Red Hat
Component: libvirt
Version: 8.4
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: 8.4
Assignee: Virtualization Maintenance
QA Contact: Han Han
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-02-07 02:16 UTC by Han Han
Modified: 2021-02-18 16:18 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-02-18 16:18:08 UTC
Type: Bug
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Han Han 2021-02-07 02:16:29 UTC
Description of problem:
When describing the features of libvirt, the libvirt doc uses implicit words like "some, almost". For example:
https://libvirt.org/formatdomain.html
Note that the vhost server replaces both the disk frontend and backend thus almost all of the disk properties can't be configured via the <disk> XML for this disk type.

Here we should say which properties are supported and which are not.

Comment 1 Pavel Hrdina 2021-02-18 16:18:08 UTC
This is way too generic BZ. We basically should improve the whole libvirt XML documentation and that is not downstream material.

I've created an upstream issue to track this https://gitlab.com/libvirt/libvirt/-/issues/134 and will close this BZ.


Note You need to log in before you can comment on or make changes to this bug.