[libvirt PATCH] docs: Add pci-addresses.rst

[Cornelia Huck]

On Tue, 14 Apr 2020 19:53:05 +0200
Andrea Bolognani <abologna at redhat.com> wrote:

> This document describes the relationship between PCI addresses as
> seen in the domain XML and by the guest OS, which is a topic that
> people get confused by time and time again.
> 
> Signed-off-by: Andrea Bolognani <abologna at redhat.com>
> ---
>  docs/formatdomain.html.in |   6 +-
>  docs/pci-addresses.rst    | 184 ++++++++++++++++++++++++++++++++++++++
>  2 files changed, 189 insertions(+), 1 deletion(-)
>  create mode 100644 docs/pci-addresses.rst
> 

(...)

> diff --git a/docs/pci-addresses.rst b/docs/pci-addresses.rst
> new file mode 100644
> index 0000000000..96c6466899
> --- /dev/null
> +++ b/docs/pci-addresses.rst
> @@ -0,0 +1,184 @@
> +========================================
> +PCI addresses in domain XML and guest OS
> +========================================
> +
> +.. contents::
> +
> +When discussing PCI addresses, it's important to understand the the
> +relationship between the addresses that can be seen in the domain XML
> +and those that are visible inside the guest OS.
> +
> +
> +Simple cases
> +============

(...)

> +More complex cases
> +==================

(...)

I'm wondering whether it is worth mentioning zPCI under 'More complex
cases', or maybe under 'Completely wacky cases', as the PCI addresses a
Linux guest will generate do not have any relation to whatever
addresses are used in the XML at all, but only to the zPCI attributes?