Bug 1925848

Summary:	docs: More explicit description in libvirt docs
Product:	Red Hat Enterprise Linux Advanced Virtualization	Reporter:	Han Han <hhan>
Component:	libvirt	Assignee:	Virtualization Maintenance <virt-maint>
Status:	CLOSED DEFERRED	QA Contact:	Han Han <hhan>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	8.4	CC:	lmen, phrdina, virt-maint, xuzhang
Target Milestone:	rc	Keywords:	Documentation
Target Release:	8.4
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2021-02-18 16:18:08 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

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.