On Thu, May 21, 2020 at 03:09:33PM -0500, Jonathon Jongsma wrote:
> In response to a comment by Daniel Berrange about documentation on my previous
> patch series, I noticed that the node device xml format documentation appears
> to be split between two different pages. It seems better to document the schema
> fully on the formatdomain page and refer to it from the other page. Another
> small patch fixes a documentation error.
>
> Jonathon Jongsma (2):
> docs: Fix names for PF and VF PCI device capabilities
> docs: Document full node device xml in formatnode.html.in
>
> docs/drvnodedev.html.in | 127 ++++------------------------------------
> docs/formatnode.html.in | 74 +++++++++++++++++++++--
> 2 files changed, 83 insertions(+), 118 deletions(-)
I pushed it with the following squashed to the second patch:
diff --git a/docs/drvnodedev.html.in b/docs/drvnodedev.html.in
index 293450ebb4..e28af4e737 100644
--- a/docs/drvnodedev.html.in
+++ b/docs/drvnodedev.html.in
@@ -143,11 +143,12 @@
A PCI device capable of creating mediated devices will include a nested
capability <code>mdev_types</code> which enumerates all supported mdev
types on the physical device, along with the type attributes available
- through sysfs. A detailed description of the XML format for the mdev
- capability can be found <a href="formatnode.html#MDEVCap">here</a>.
+ through sysfs. A detailed description of the XML format for the
+ <code>mdev_types</code> capability can be found
+ <a href="formatnode.html#MDEVCap">here</a>.
</p>
<p>
- The following example shows how we might represent an Nvidia GPU device
+ The following example shows how we might represent an NVIDIA GPU device
that supports mediated devices. See below for <a href="#MDEV">more
information about mediated devices</a>.
</p>
@@ -183,8 +184,8 @@
only appear on the mdev virtual bus. Therefore, no detach/reattach
procedure from/to the host driver procedure is involved even though
mediated devices are used in a direct device assignment manner. A
- detailed description of the XML format for the mdev capability can be
- found <a href="formatnode.html#mdev">here</a>.
+ detailed description of the XML format for the <code>mdev</code>
+ capability can be found <a href="formatnode.html#mdev">here</a>.
</p>
<h3>Example of a mediated device</h3>
Erik
